Class A_CmsUpdateDBPart

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.util.Map<java.lang.String,​java.lang.String> m_poolData
      The connection data to use.
      protected java.util.Map<java.lang.String,​java.lang.String> m_queries
      A map holding all SQL queries.
    • Constructor Summary

      Constructors 
      Constructor Description
      A_CmsUpdateDBPart()
      Default constructor.
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void execute​(java.util.Map<java.lang.String,​java.lang.String> dbPoolData)
      Executes the update part.
      java.util.Map<java.lang.String,​java.lang.String> getPoolData()
      Returns the database pool Data.
      protected java.lang.String getPropertyFileLocation()
      Returns the default property file location.
      protected abstract void internalExecute​(CmsSetupDb setupDb)
      Does the hard work.
      protected boolean isKeepHistory()
      Returns the keep History parameter value.
      protected void loadQueryProperties​(java.lang.String propertyFilename)
      Loads a Java properties hash containing SQL queries.
      java.lang.String readQuery​(java.lang.String queryKey)
      Searches for the SQL query with the specified key.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • m_poolData

        protected java.util.Map<java.lang.String,​java.lang.String> m_poolData
        The connection data to use.
      • m_queries

        protected java.util.Map<java.lang.String,​java.lang.String> m_queries
        A map holding all SQL queries.
    • Method Detail

      • getPoolData

        public java.util.Map<java.lang.String,​java.lang.String> getPoolData()
        Returns the database pool Data.

        Returns:
        the database pool Data
      • readQuery

        public java.lang.String readQuery​(java.lang.String queryKey)
        Searches for the SQL query with the specified key.

        Parameters:
        queryKey - the SQL query key
        Returns:
        the the SQL query in this property list with the specified key
      • getPropertyFileLocation

        protected java.lang.String getPropertyFileLocation()
        Returns the default property file location.

        Returns:
        the default property file location
      • internalExecute

        protected abstract void internalExecute​(CmsSetupDb setupDb)
                                         throws java.sql.SQLException
        Does the hard work.

        Parameters:
        setupDb - the db connection interface
        Throws:
        java.sql.SQLException - if something goes wrong
      • isKeepHistory

        protected boolean isKeepHistory()
        Returns the keep History parameter value.

        Returns:
        the keep History parameter value
      • loadQueryProperties

        protected void loadQueryProperties​(java.lang.String propertyFilename)
                                    throws java.io.IOException
        Loads a Java properties hash containing SQL queries.

        Parameters:
        propertyFilename - the package/filename of the properties hash
        Throws:
        java.io.IOException - if the sql queries property file could not be read