com.stc.eindex.master.search.potdup
Class PotentialDuplicateSummary

java.lang.Object
  com.stc.eindex.objects.ObjectNode
      com.stc.eindex.master.search.potdup.PotentialDuplicateSummary

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

public class PotentialDuplicateSummary

extends ObjectNode

The PotentialDuplicateSummary class represents an object containing a potential duplicate pair returned by a call to lookupPotentialDuplicates. A potential duplicate search returns an iterator of PotentialDuplicateSummary objects.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.stc.eindex.objects.ObjectNode

indexMap, mChildrenHashMap, mChildTags, mFields, mParent, mParentTag, mPartOfIndex, mPosition, mTag, mVersion

Constructor Summary

PotentialDuplicateSummary(MasterController mc, PotentialDuplicateSearchObject searchObj, java.lang.String id, java.lang.String euid1, java.lang.String euid2, java.lang.String status, java.lang.String reason, float weight, java.lang.String systemCode, java.lang.String createUser, java.util.Date createDate, java.lang.String resolvedUser, java.util.Date resolvedDate, java.lang.String comment)
Creates a new instance of the PotentialDuplicateSummary class.

Method Summary

PotentialDuplicateIterator	getAssociatedPotentialDuplicates() Retrieves additional potential duplicate records associated with the potential duplicate records contained in the PotentialDuplicateSummary object.
java.util.Date	getCreateDate() Retrieves the date the potential duplicate listing was created from the PotentialDuplicateSummary object.
java.lang.String	getCreateUser() Retrieves the create user ID from the PotentialDuplicateSummary object.
java.lang.String	getEUID1() Retrieves the value of the first EUID from the PotentialDuplicateSummary object.
java.lang.String	getEUID2() Retrieves the value of the second EUID from the PotentialDuplicateSummary object.
java.lang.String	getId() Retrieves the value of the potential duplicate ID from the PotentialDuplicateSummary object.
ObjectNode	getObject1() Retrieves fields from one EUID object in the PotentialDuplicateSummary object.
ObjectNode	getObject2() Retrieves fields from the second EUID object in the PotentialDuplicateSummary object.
java.lang.String	getReason() Retrieves the reason the records in the PotentialDuplicateSummary object were marked as potential duplicates.
java.lang.String	getResolvedComment() Retrieves the comment generated when the potential duplicate records in the PotentialDuplicateSummary object were resolved.
java.util.Date	getResolvedDate() Retrieves the date the potential duplicate listing was resolved from the PotentialDuplicateSummary object.
java.lang.String	getResolvedUser() Retrieves the resolved user ID from the PotentialDuplicateSummary object.
java.lang.String	getStatus() Retrieves the value of the potential duplicate status of the records in the PotentialDuplicateSummary object.
java.lang.String	getSystemCode() Retrieves the system code from the PotentialDuplicateSummary object.
float	getWeight() Retrieves the matching probability weight of the records in the PotentialDuplicateSummary object.
java.lang.String	toString() Retrieves a string representation of the potential duplicate ID, EUID1, EUID2, and weight fields from the PotentialDuplicateSummary object.

Methods inherited from class com.stc.eindex.objects.ObjectNode

add, addChild, addChildHard, addChildNoFlagSet, addChildren, addChildToTypeArrayList, clearChildrenForType, clearField, copy, createChildIndex, deleteChild, deleteChild, equals, getAllChildrenFromHashMap, getChild, getChild, getChildKey, getChildrenForType, getChildSuperKey, getField, getFieldTypes, getFlag, getObjectId, getParent, getParentTag, getValue, getValueObject, hasFieldReadAccess, hasFieldUpdateAccess, hashCode, hasObjectAddAccess, hasObjectDeleteAccess, hasObjectReadAccess, hasObjectUpdateAccess, isAdded, isChanged, isKeyChanged, isKeyIndexable, isKeyType, isKeyValid, isNew, isNull, isNullable, isRegularKeyIndexable, isRemoved, isSearched, isUpdated, isVisible, obtainKey, obtainSuperKey, pGetChildren, pGetChildren, pGetChildTags, pGetFieldNames, pGetFields, pGetFieldUpdateLogs, pGetFieldValues, pGetFlagString, pGetKey, pGetSuperKey, pGetTag, pGetType, pGetType, recalculateIndex, removeChild, removeChild, removeChildForType, removeChildIndex, removeChildren, removeChildren, reset, resetAll, setAddFlag, setChanged, setFieldReadAccess, setFieldUpdateAccess, setFieldUpdateLogs, setFlag, setKey, setKeyChangeFlag, setKeyType, setNull, setNullable, setObjectAddAccess, setObjectDeleteAccess, setObjectReadAccess, setObjectUpdateAccess, setParent, setRemoveFlag, setSearched, setUpdateFlag, setValue, setVisible, structCopy, unChange, update, updateChild, updateIfChanged, updateIfNotEqual, updateIfNotNull, updateIfNotNull

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PotentialDuplicateSummary

public PotentialDuplicateSummary(MasterController mc,
                                 PotentialDuplicateSearchObject searchObj,
                                 java.lang.String id,
                                 java.lang.String euid1,
                                 java.lang.String euid2,
                                 java.lang.String status,
                                 java.lang.String reason,
                                 float weight,
                                 java.lang.String systemCode,
                                 java.lang.String createUser,
                                 java.util.Date createDate,
                                 java.lang.String resolvedUser,
                                 java.util.Date resolvedDate,
                                 java.lang.String comment)
                          throws ObjectException

Creates a new instance of the PotentialDuplicateSummary class.

Parameters:

mc - A handle to the MasterController instance.

searchObj - A PotentialDuplicateSearchObject search object.

id - A string containing a potential duplicate ID.

euid1 - A string containing the first EUID in a potential duplicate pair.

euid2 - A string containing the second EUID in a potential duplicate pair.

status - A string containing the status of the potential duplicate pair.

reason - A string containing the reason the records were listed as potential duplicates.

weight - A floating integer indicating the matching probability between the two records.

systemCode - A string containing the processing code of the system that caused the potential duplication.

createUser - A string containing the logon ID of the user who performed the transaction causing the potential duplication.

createDate - The date the potential duplicate listing was created.

resolvedUser - A string containing the logon ID of the user who resolved the potential duplicate records.

resolvedDate - The date the potential duplicate listing was resolved.

comment - A string containing a comment about the potential duplicate records.

Throws:

ObjectException - Thrown if an error occurs while creating the PotentialDuplicateSummary object.

Method Detail

getAssociatedPotentialDuplicates

public PotentialDuplicateIterator getAssociatedPotentialDuplicates()
                                                            throws java.rmi.RemoteException,
                                                                   ProcessingException

Retrieves additional potential duplicate records associated with the potential duplicate records contained in the PotentialDuplicateSummary object. If the resulting iterator only contains one record, there are no associated potential duplicates.

Parameters:

None.

Returns:

PotentialDuplicateIterator - An iterator of PotentialDuplicateSummary objects.

Throws:

ProcessingException - Thrown if an error occurs while processing the associated potential duplicate records.

java.rmi.RemoteException - Thrown if the connection to the remote server goes down during processing.

getCreateDate

public java.util.Date getCreateDate()
                             throws ObjectException

Retrieves the date the potential duplicate listing was created from the PotentialDuplicateSummary object.

Parameters:

None.

Returns:

java.util.Date - The create date of the potential duplicate listing.

Throws:

ObjectException - Thrown if the date could not be retrieved.

getCreateUser

public java.lang.String getCreateUser()
                               throws ObjectException

Retrieves the create user ID from the PotentialDuplicateSummary object.

Parameters:

None.

Returns:

String - A user logon ID.

Throws:

ObjectException - Thrown if the user ID could not be retrieved.

getEUID1

public java.lang.String getEUID1()
                          throws ObjectException

Retrieves the value of the first EUID from the PotentialDuplicateSummary object.

Parameters:

None.

Returns:

String - An EUID.

Throws:

ObjectException - Thrown if the EUID could not be retrieved.

getEUID2

public java.lang.String getEUID2()
                          throws ObjectException

Retrieves the value of the second EUID from the PotentialDuplicateSummary object.

Parameters:

None.

Returns:

String - An EUID.

Throws:

ObjectException - Thrown if the EUID could not be retrieved.

getId

public java.lang.String getId()
                       throws ObjectException

Retrieves the value of the potential duplicate ID from the PotentialDuplicateSummary object.

Parameters:

None.

Returns:

String - The value of the potential duplicate ID.

Throws:

ObjectException - Thrown if the ID could not be retrieved.

getObject1

public ObjectNode getObject1()

Retrieves fields from one EUID object in the PotentialDuplicateSummary object. The fields retrieved are specified by PotentialDuplicateSearchObject.getFieldsToRetrieve.

Parameters:

None.

Returns:

ObjectNode - The specified fields in the given object.

Throws:

None.

getObject2

public ObjectNode getObject2()

Retrieves fields from the second EUID object in the PotentialDuplicateSummary object. The fields retrieved are specified by PotentialDuplicateSearchObject.getFieldsToRetrieve.

Parameters:

None.

Returns:

ObjectNode - The specified fields in the given object.

Throws:

None.

getReason

public java.lang.String getReason()
                           throws ObjectException

Retrieves the reason the records in the PotentialDuplicateSummary object were marked as potential duplicates.

Parameters:

None.

Returns:

String - The reason for the potential duplication.

Throws:

ObjectException - Thrown if the reason could not be retrieved.

getResolvedComment

public java.lang.String getResolvedComment()
                                    throws ObjectException

Retrieves the comment generated when the potential duplicate records in the PotentialDuplicateSummary object were resolved.

Parameters:

None.

Returns:

String - A comment describing the resolution.

Throws:

ObjectException - Thrown if the comment could not be retrieved.

getResolvedDate

public java.util.Date getResolvedDate()
                               throws ObjectException

Retrieves the date the potential duplicate listing was resolved from the PotentialDuplicateSummary object.

Parameters:

None.

Returns:

java.util.Date - The resolved date of the potential duplicate listing.

Throws:

ObjectException - Thrown if the date could not be retrieved.

getResolvedUser

public java.lang.String getResolvedUser()
                                 throws ObjectException

Retrieves the resolved user ID from the PotentialDuplicateSummary object.

Parameters:

None.

Returns:

String - A user logon ID.

Throws:

ObjectException - Thrown if the user ID could not be retrieved.

getStatus

public java.lang.String getStatus()
                           throws ObjectException

Retrieves the value of the potential duplicate status of the records in the PotentialDuplicateSummary object.

Parameters:

None.

Returns:

String - The status of the potential duplicate records. One of these values is returned:

• A - Indicates the pair has been auto resolved.
• R - Indicates the pair has been resolved.
• Unresolved.

Throws:

ObjectException - Thrown if the status could not be retrieved.

getSystemCode

public java.lang.String getSystemCode()
                               throws ObjectException

Retrieves the system code from the PotentialDuplicateSummary object.

Parameters:

None.

Returns:

String - The processing code of the system that caused the potential duplication.

Throws:

ObjectException - Thrown if the system code could not be retrieved.

getWeight

public float getWeight()
                throws ObjectException

Retrieves the matching probability weight of the records in the PotentialDuplicateSummary object.

Parameters:

None.

Returns:

Float - The matching probability weight between two records.

Throws:

ObjectException - Thrown if the weight could not be retrieved.

toString

public java.lang.String toString()

Retrieves a string representation of the potential duplicate ID, EUID1, EUID2, and weight fields from the PotentialDuplicateSummary object.

Parameters:

None.

Overrides:

toString in class ObjectNode

Returns:

String - The potential duplicate ID, EUID1, EUID2, and weight field values.

Throws:

None.