com.ibm.commerce.foundation.dataload.idresolve

Class IDResolveRequest

  • java.lang.Object
    • com.ibm.commerce.foundation.dataload.idresolve.IDResolveRequest

  • public class IDResolveRequest
extends java.lang.Object
    ID Resolver request. It is the input to ID resolver. It contains the following properties:
    • tableName -- the name of the table which the ID resolve to work on.
    • UniqueIndexData -- a map contains the data to be resolved to a primary key. The key is the column name.
    • uniqueIndexFixedValue -- a map contains the data to be resolved to a primary key. The key is the column name.
    • generateNewKey -- a boolean value to indicate if the primary key cannot be resolved whether it needs to generate a new key
    • startKey and endKey. There are optional. If they are set, it means that it uses a fixed key range to get the generated keys.

    • Constructor Detail

      • IDResolveRequest

        public IDResolveRequest(java.lang.String aTableName)
        Constructor
        Parameters:
        aTableName - a table name

      • IDResolveRequest

        public IDResolveRequest(java.lang.String aTableName,
                        java.util.Map aUniqueIndexData)
        Constructor
        Parameters:
        aTableName - a table name
        aUniqueIndexData - a unique index data map, key is the column name, value is the unique index data

    • Method Detail

      • isGenerateNewKey

        public boolean isGenerateNewKey()
        Check if generate new key is true or false. If generate new key is true, it means if the ID cannot be resolved, a new key will be generated.
        Returns:
        true if the generateNewKey is set to true

      • setGenerateNewKey

        public void setGenerateNewKey(boolean aGenerateNewKey)
        Set the generateNewKey value
        Parameters:
        aGenerateNewKey - indicate whether generate new key

      • getTableName

        public java.lang.String getTableName()
        Get table name to be used in the ID resolver
        Returns:
        the table name

      • setTableName

        public void setTableName(java.lang.String aTableName)
        Set the table name
        Parameters:
        aTableName - a table name

      • getUniqueIndexData

        public java.util.Map getUniqueIndexData()
        Get the unique index data
        Returns:
        the unique index data

      • setUniqueIndexData

        public void setUniqueIndexData(java.util.Map aUniqueIndexData)
        Set the unique index data
        Parameters:
        aUniqueIndexData - unique index data

      • getUniqueIndexFixedValue

        public java.util.Map getUniqueIndexFixedValue()
        Get the unique index fixed value.
        Returns:
        the unique index fixed value

      • setUniqueIndexFixedValue

        public void setUniqueIndexFixedValue(java.util.Map aUniqueIndexFixedValue)
        Set the unique index fixed value
        Parameters:
        aUniqueIndexFixedValue - unique index fixed value map

      • getEndKey

        public java.lang.Long getEndKey()
        get the end key
        Returns:
        the end key

      • setEndKey

        public void setEndKey(java.lang.Long anEndKey)
        set the end key
        Parameters:
        anEndKey -

      • getStartKey

        public java.lang.Long getStartKey()
        Get the start key
        Returns:
        the start key

      • setStartKey

        public void setStartKey(java.lang.Long aStartKey)
        Set the start key
        Parameters:
        aStartKey - start key

      • getPrimaryKeyColumnName

        public java.lang.String getPrimaryKeyColumnName()
        Get the primary key column name
        Returns:
        the primary key column name

      • setPrimaryKeyColumnName

        public void setPrimaryKeyColumnName(java.lang.String aPrimaryKeyColumnName)
        Set the primary key column name
        Parameters:
        aPrimaryKeyColumnName - a primary key column name.
Skip navigation links