Package org.odpi.openmetadata.commonservices.repositoryhandler

Class DuplicateEntityIterator

java.lang.Object

org.odpi.openmetadata.commonservices.repositoryhandler.DuplicateEntityIterator

public class DuplicateEntityIterator
extends Object

DuplicateEntityIterator retrieves the list of entities that need to be processed for a specific entity. The first entity returned is the principle entity or its consolidated replacement. After that are the peer duplicates. Note: this class is not thread-safe - use only within a single-threaded request.

Constructor Summary

Constructors

Constructor	Description
DuplicateEntityIterator(RepositoryHandler repositoryHandler, RepositoryErrorHandler errorHandler, InvalidParameterHandler invalidParameterHandler, String userId, EntityDetail startingEntity, String entityTypeName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Construct the duplicate entity iterator.

Method Summary

Modifier and Type	Method	Description
EntityDetail	getConsolidatedEntity(String userId, EntityDetail startingEntity, String startingEntityTypeName, boolean forLineage, Date effectiveTime, String methodName)	Return the entity at the other end of the requested relationship type.

Methods inherited from class java.lang.Object

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

Constructor Details

DuplicateEntityIterator

public DuplicateEntityIterator(RepositoryHandler repositoryHandler,
 RepositoryErrorHandler errorHandler,
 InvalidParameterHandler invalidParameterHandler,
 String userId,
 EntityDetail startingEntity,
 String entityTypeName,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 String methodName)
                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Construct the duplicate entity iterator.

Parameters:

repositoryHandler - this repository handler

errorHandler - generates error messages and exceptions

invalidParameterHandler - handles parameter errors

userId - calling user

startingEntity - entity to start processing on

entityTypeName - type of entities that the iterator is working with

forLineage - is this a lineage request

forDuplicateProcessing - is this a duplicate processing request

effectiveTime - what is the effective time needed by the caller

methodName - calling method

Throws:

InvalidParameterException - bad parameters

UserNotAuthorizedException - broader security failure

PropertyServerException - logic error

Method Details

getConsolidatedEntity

public EntityDetail getConsolidatedEntity(String userId,
 EntityDetail startingEntity,
 String startingEntityTypeName,
 boolean forLineage,
 Date effectiveTime,
 String methodName)
                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the entity at the other end of the requested relationship type. The assumption is that this is a 0..1 relationship so one entity (or null) is returned. If lots of relationships are found then the PropertyServerException is thrown.

Parameters:

userId - user making the request

startingEntity - starting entity

startingEntityTypeName - starting entity's type name

forLineage - the query is to support lineage retrieval

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

methodName - name of calling method

Returns:

retrieved entity or null

Throws:

InvalidParameterException - bad starting entity

PropertyServerException - problem accessing the property server

UserNotAuthorizedException - security access problem