psdi.app.recontask.engine.dataset

Class AssetDataSet

java.lang.Object

psdi.app.recontask.engine.dataset.CommonDataSet

psdi.app.recontask.engine.dataset.AssetDataSet

All Implemented Interfaces:

DataSet

public class AssetDataSet
extends CommonDataSet

recon data set for Assets.

Author:

Qiang(John) Wen

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	ASSET_ATTRIBUTES_EXCLUDE
static java.lang.String[]	ITEM_ATTRIBUTES_EXCLUDE
static java.lang.String	OBJECT_ASSET
static java.lang.String	OBJECT_ASSETSPEC
static java.lang.String	OBJECT_ITEM
static java.lang.String	OBJECT_ITEMSPEC
static java.lang.String[]	RECON_LINK_DOMAIN_EXCLUDE
static java.lang.String	ROOTMAXVAR

Constructor Summary

Constructors

Constructor and Description
AssetDataSet()

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getAttributesExcludeList(java.lang.String objectname) Not all attributes of an object may be available for linking, comparison filtering, or comparison.
java.lang.String[]	getExtraTableNamesForComparison(java.lang.String tableName) Returns null.
java.lang.String	getFixedTaskFilterWhereClause() Returns the where clause for filtering the main object to ensure that it's classtructureid, if there is one, is a decendant of the root classtructureid as defined in a maxvar.
java.lang.String	getMainObjectName() The data set class needs to implement this method to provide the name of its main object that will be reconciled.
java.lang.String	getMainObjectUID() Retrieves the unique ID of the main object from Maximo meta data.
java.lang.String[]	getObjectNameDomainExcludeList(java.lang.String objectName) Returns a list of elements to exclude from the domain.
java.lang.String	getObjectNameDomainID() All objects, including class spec objects, that can be linked or compared with the data set must be defined in a synonym domain.
java.lang.String[][]	getObjectSpecPairs() If the reconciliation can be performed on a class specification of an object, the recon engine will read in the spec object data along with that of the master object.
ResultTableAttributes	getReconLinkAttributeNamesForLink(boolean isDataSet1) Returns the mapping between the actual columns in the reconlink table and this data set's proxy names for them.
ResultTableAttributes	getReconResultAttributeNamesForComparison(boolean isDataSet1) The data set uses this method to map database table columns that are specific to the data set to the ones in the RECONRESULT table for the successful or unsuccessful results of the comparison phase.
ResultTableAttributes	getReconResultAttributeNamesForLink(boolean isDataSet1) Returns the mapping between the actual columns in the reconresult table and this data set's proxy names for them.
int	getRecordCount(java.util.Map uidKeys, java.lang.String objectName, java.lang.String classStructureID) Returns -1.
java.lang.String	getRootSpecMaxVar(java.lang.String objectname) In many cases the root classstructure id for class specs of a data set is defined in a maxvar.
java.lang.String	getTableColumnNameForTaskFilter(java.lang.String attributeName) Returns the column name based on an attribute name encountered in the task filter being used with the data set.
java.lang.String	getTableJoinWhereClauseForComparison(java.lang.String tableName, java.util.Map uidKeys) Throws IllegalArgumentException exception
java.lang.String	getTableJoinWhereClauseForTaskFilter(java.lang.String tableName) Returns the joining clause for task filter based on a table name.
java.lang.String	getTableNameForTaskFilter(java.lang.String attributeName) Returns the table name in which the passed in attribute name resides.
java.lang.String	getTaskFilterAttributesDomainID() The available attributes of task filters for any data set are defined by synonym domain.
boolean	isUnitOfMeasureAllowed(java.lang.String objectName) Determines whether the dataset allows use of the "Unit of Measure" attribute for all or part of its subtypes.

Methods inherited from class psdi.app.recontask.engine.dataset.CommonDataSet

getDataSetName, getMainObjectPrimaryKeys, getMasterForSpec, getObjectUID, getReconLinker, getRootClassstructureID, getSpecForMaster, getTaskFilterClause, readMaxVar, setContext, setDataSetName, setTaskFilterClause

Methods inherited from class java.lang.Object

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

Field Detail

OBJECT_ASSET

public static final java.lang.String OBJECT_ASSET

See Also:

Constant Field Values

OBJECT_ASSETSPEC

public static final java.lang.String OBJECT_ASSETSPEC

See Also:

Constant Field Values

OBJECT_ITEM

public static final java.lang.String OBJECT_ITEM

See Also:

Constant Field Values

OBJECT_ITEMSPEC

public static final java.lang.String OBJECT_ITEMSPEC

See Also:

Constant Field Values

ROOTMAXVAR

public static final java.lang.String ROOTMAXVAR

See Also:

Constant Field Values

RECON_LINK_DOMAIN_EXCLUDE

public static final java.lang.String[] RECON_LINK_DOMAIN_EXCLUDE

ASSET_ATTRIBUTES_EXCLUDE

public static final java.lang.String[] ASSET_ATTRIBUTES_EXCLUDE

ITEM_ATTRIBUTES_EXCLUDE

public static final java.lang.String[] ITEM_ATTRIBUTES_EXCLUDE

Constructor Detail

AssetDataSet

public AssetDataSet()

Method Detail

getMainObjectName

public java.lang.String getMainObjectName()

Description copied from interface: DataSet

The data set class needs to implement this method to provide the name of its main object that will be reconciled. The name can be in either upper case or lower case or mixed.

Returns:

The main object name of this data set.

getMainObjectUID

public java.lang.String getMainObjectUID()
                                  throws java.rmi.RemoteException

Description copied from class: CommonDataSet

Retrieves the unique ID of the main object from Maximo meta data.

Specified by:

getMainObjectUID in interface DataSet

Overrides:

getMainObjectUID in class CommonDataSet

Returns:

The unique ID.

Throws:

java.rmi.RemoteException

See Also:

DataSet.getMainObjectUID

getTaskFilterAttributesDomainID

public java.lang.String getTaskFilterAttributesDomainID()

Description copied from interface: DataSet

The available attributes of task filters for any data set are defined by synonym domain. The data set class provides the ID of the domain using this method. This method must be implemented by all data set classes. It is used in both the recon engine and the recon taks filter application.
Notice that the attributes defined in the domain may or may not be from the main table, and their names may or may not be the same as the corresponding column names in the database tables.

Returns:

The synonyn domain ID that defines the list of filter attributes.

getFixedTaskFilterWhereClause

public java.lang.String getFixedTaskFilterWhereClause()
                                               throws MXException,
                                                      java.rmi.RemoteException,
                                                      java.sql.SQLException

Description copied from class: CommonDataSet

Returns the where clause for filtering the main object to ensure that it's classtructureid, if there is one, is a decendant of the root classtructureid as defined in a maxvar. The data set providers that extend this class should and the return of this class with the one it generates itself.

Specified by:

getFixedTaskFilterWhereClause in interface DataSet

Overrides:

getFixedTaskFilterWhereClause in class CommonDataSet

Returns:

The global where clause for filtering in link, or null if none is to be defined.

Throws:

MXException

java.rmi.RemoteException

java.sql.SQLException

See Also:

DataSet.getFixedTaskFilterWhereClause

getObjectNameDomainID

public java.lang.String getObjectNameDomainID()

Description copied from interface: DataSet

All objects, including class spec objects, that can be linked or compared with the data set must be defined in a synonym domain. The recon GUI and engine will call this method to get the ID of this domain.

Returns:

The object names domain ID.

getRecordCount

public int getRecordCount(java.util.Map uidKeys,
                          java.lang.String objectName,
                          java.lang.String classStructureID)
                   throws MXException,
                          java.rmi.RemoteException,
                          java.sql.SQLException

Description copied from class: CommonDataSet

Returns -1.

Specified by:

getRecordCount in interface DataSet

Overrides:

getRecordCount in class CommonDataSet

Parameters:

uidKeys - The top level main object key values for this comparison.

objectName - The name of the table to be counted.

classStructureID - The class structure ID if the table involved is a spec object

Returns:

record count of the given table, or -1 if the data set doesn't provide a special counting method.

Throws:

MXException

java.rmi.RemoteException

java.sql.SQLException

See Also:

DataSet.getRecordCount

getReconResultAttributeNamesForComparison

public ResultTableAttributes getReconResultAttributeNamesForComparison(boolean isDataSet1)

Description copied from interface: DataSet

The data set uses this method to map database table columns that are specific to the data set to the ones in the RECONRESULT table for the successful or unsuccessful results of the comparison phase. The values of these columns are copied from attributes of the objects that are involved during the comparison process.
The names are provided in the form of a ResultTableAttributes object which maintains a list of attribute names and the reconciliation result table (RECONLINK and RECONRESULT) column names they map to. The data set class normally instantiates a ResultTableAttributes, adds the attributes and returns it.

Returns:

The data set specific RECONRESULT table columns.

See Also:

ResultTableAttributes

getReconLinkAttributeNamesForLink

public ResultTableAttributes getReconLinkAttributeNamesForLink(boolean isDataSet1)

Returns the mapping between the actual columns in the reconlink table and this data set's proxy names for them.

Returns:

ResultTableAttributes - the mapping between the actual link table columns and the data set's equivalents of them - for link.

See Also:

ResultTableAttributes

getReconResultAttributeNamesForLink

public ResultTableAttributes getReconResultAttributeNamesForLink(boolean isDataSet1)

Returns the mapping between the actual columns in the reconresult table and this data set's proxy names for them.

Returns:

ResultTableAttributes - the mapping between the actual result table columns and the data set's equivalents of them - for link.

See Also:

ResultTableAttributes

getTableColumnNameForTaskFilter

public java.lang.String getTableColumnNameForTaskFilter(java.lang.String attributeName)

Returns the column name based on an attribute name encountered in the task filter being used with the data set.

Specified by:

getTableColumnNameForTaskFilter in interface DataSet

Overrides:

getTableColumnNameForTaskFilter in class CommonDataSet

Parameters:

- - String the column name.

Returns:

the column name based on an attribute name encountered in the task filter being used with the data set.

See Also:

DataSet.getTableColumnNameForTaskFilter

getTableJoinWhereClauseForTaskFilter

public java.lang.String getTableJoinWhereClauseForTaskFilter(java.lang.String tableName)

Returns the joining clause for task filter based on a table name.

Specified by:

getTableJoinWhereClauseForTaskFilter in interface DataSet

Overrides:

getTableJoinWhereClauseForTaskFilter in class CommonDataSet

Parameters:

the - name of the table to get the joining table for.

Returns:

the joining clause.

See Also:

DataSet.getTableJoinWhereClauseForTaskFilter

getTableNameForTaskFilter

public java.lang.String getTableNameForTaskFilter(java.lang.String attributeName)

Returns the table name in which the passed in attribute name resides.

Specified by:

getTableNameForTaskFilter in interface DataSet

Overrides:

getTableNameForTaskFilter in class CommonDataSet

Parameters:

attributeName - - the String the column name.

Returns:

- String the table name.

See Also:

DataSet.getTableNameForTaskFilter

getExtraTableNamesForComparison

public java.lang.String[] getExtraTableNamesForComparison(java.lang.String tableName)

Description copied from class: CommonDataSet

Returns null.

Specified by:

getExtraTableNamesForComparison in interface DataSet

Overrides:

getExtraTableNamesForComparison in class CommonDataSet

Parameters:

tableName - The name of the table from which data is to be retrieved.

Returns:

The list of names of extra tables that might be involved, or null if none is needed.

See Also:

DataSet.getExtraTableNamesForComparison

getTableJoinWhereClauseForComparison

public java.lang.String getTableJoinWhereClauseForComparison(java.lang.String tableName,
                                                             java.util.Map uidKeys)
                                                      throws MXException,
                                                             java.rmi.RemoteException,
                                                             java.sql.SQLException

Description copied from class: CommonDataSet

Throws IllegalArgumentException exception

Specified by:

getTableJoinWhereClauseForComparison in interface DataSet

Overrides:

getTableJoinWhereClauseForComparison in class CommonDataSet

Parameters:

tableName - The name of the table from which data is to be retrieved.

uidKeys - The key values of the main table. this should at least include the unique IDs and primary key values. This parameter maps attribute names to attribute values.

Returns:

The where clause that joins the table and the main object table.

Throws:

MXException

java.rmi.RemoteException

java.sql.SQLException

See Also:

DataSet.getTableJoinWhereClauseForComparison

getRootSpecMaxVar

public java.lang.String getRootSpecMaxVar(java.lang.String objectname)

Description copied from class: CommonDataSet

In many cases the root classstructure id for class specs of a data set is defined in a maxvar. If so the classs can make use of the implementation of the getRootClassstructureID in CommonDataSet. Data set classes that extends the CommonDataSet will only need to implement this method to provide the name of the maxvar. It won't have to implement the getRootClassstructureID method itself.

Specified by:

getRootSpecMaxVar in class CommonDataSet

Returns:

The name of the maxvar which defines the root class structure id

getAttributesExcludeList

public java.lang.String[] getAttributesExcludeList(java.lang.String objectname)

Description copied from interface: DataSet

Not all attributes of an object may be available for linking, comparison filtering, or comparison. This method is used by the data set to exclude some attributes from the attribute list in the GUI when an object is selected.

Returns:

names of attributes to exclude from the attribute list, null if none is to be excluded.

See Also:

getObjectNameDomainID

getObjectSpecPairs

public java.lang.String[][] getObjectSpecPairs()

Description copied from interface: DataSet

If the reconciliation can be performed on a class specification of an object, the recon engine will read in the spec object data along with that of the master object. The data set does not need to provide a SQL where clause of how to join the spec objects to their master objects. It only need to implement this method to pair up all the master objects and their spec objects.
The master and spec object pairs are provided as an array, with every element of the array lists one pair. Each element in turn is a String array with 2 elements. The 1st element is the master object name and the 2nd element is the spec object name.

Returns:

The object-spec pairs, or null if spec is not used in this data set.

getObjectNameDomainExcludeList

public java.lang.String[] getObjectNameDomainExcludeList(java.lang.String objectName)

Returns a list of elements to exclude from the domain.

Parameters:

objectName - Name of object that uses the domain.

Returns:

Elements to exclude from the domain.

See Also:

getObjectNameDomainID

isUnitOfMeasureAllowed

public boolean isUnitOfMeasureAllowed(java.lang.String objectName)

Determines whether the dataset allows use of the "Unit of Measure" attribute for all or part of its subtypes.

Specified by:

isUnitOfMeasureAllowed in interface DataSet

Overrides:

isUnitOfMeasureAllowed in class CommonDataSet

Parameters:

objectName - The name of a subset.

Returns:

boolean Whether or not the use of the "Unit of Measure" attribute is allowed.