com.ibm.commerce.foundation.server.services.dataaccess.db.jdbc

Class XPathSQLKeyProcessor

  • java.lang.Object
    • com.ibm.commerce.foundation.server.services.dataaccess.db.jdbc.XPathSQLKeyProcessor
  • All Implemented Interfaces:
    java.io.Serializable

    public abstract class XPathSQLKeyProcessor
extends java.lang.Object
implements java.io.Serializable
    The component extended abstract class to return the keys which will be used in the assoicated sql statement.
    See Also:
    Serialized Form

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method and Description
      abstract java.util.List getKeys(java.util.List keys, java.util.Map ahmXPathQueryParameters, int sqlPagingLimit)
      This method returns a list of keys which will be used in subsequence associated sql(s)
      void setNeedPaging(boolean iNeedPaging)
      This method sets the flag whether paging is needed.
      void setPageSize(int iPageSize)
      This method sets the paging limit.
      void setPagingStartIndex(int iPagingStartIndex)
      This method sets the paging start index.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • XPathSQLKeyProcessor

        public XPathSQLKeyProcessor()

    • Method Detail

      • getKeys

        public abstract java.util.List getKeys(java.util.List keys,
                                       java.util.Map ahmXPathQueryParameters,
                                       int sqlPagingLimit)
        This method returns a list of keys which will be used in subsequence associated sql(s)
        Parameters:
        keys - a list of the keys from the xpath sql statement.
        ahmXPathQueryParameters - The parameters from the XPath query.
        sqlPagingLimit - The paging limit of the XPath sql if it is defined in a query template file.
        Returns:
        A list of the unique keys will be used in the subsequence associated sql(s). The objects in the list are of type String. The list should not contain duplicate entries.

      • setPageSize

        public void setPageSize(int iPageSize)
        This method sets the paging limit.
        Parameters:
        iPageSize - The paging limit from client side.

      • setPagingStartIndex

        public void setPagingStartIndex(int iPagingStartIndex)
        This method sets the paging start index.
        Parameters:
        iPagingStartIndex - The paging start index from client side.

      • setNeedPaging

        public void setNeedPaging(boolean iNeedPaging)
        This method sets the flag whether paging is needed.
        Parameters:
        iNeedPaging - boolean value indicating whether paging is needed.
Skip navigation links