org.odpi.openmetadata.frameworks.discovery

Class DiscoveryContext

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase

org.odpi.openmetadata.frameworks.discovery.DiscoveryContext

All Implemented Interfaces:

Serializable

public class DiscoveryContext
extends PropertyBase

DiscoveryContext provides the exchange area for annotations discovered from analysing a specific asset.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	analysisParameters
protected DiscoveryAnnotationStore	annotationStore
protected String	assetGUID
protected DiscoveryAssetStore	assetStore
protected Date	creationDate
protected String	discoveryReportGUID
protected String	reportDescription
protected String	reportDisplayName
protected String	reportQualifiedName
protected List<String>	requestedAnnotationTypes
protected String	userId

Constructor Summary

Constructors

Constructor and Description
DiscoveryContext(DiscoveryContext template) Copy/clone Constructor
DiscoveryContext(String userId, String assetGUID, String discoveryReportGUID, Map<String,String> analysisParameters, List<String> requestedAnnotationTypes, DiscoveryAssetStore assetStore, DiscoveryAnnotationStore annotationStore) Constructor sets up the key parameters for accessing the annotations store.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) Compare the values of the supplied object with those stored in the current object.
Map<String,String>	getAnalysisParameters() Return the properties that hold the parameters used to drive the discovery service's analysis.
DiscoveryAnnotationStore	getAnnotationStore() Return the annotation store for the discovery engine.
String	getAssetGUID() Return the unique identifier of the asset being discovered.
DiscoveryAssetStore	getAssetStore() Return the asset store for the discovery engine.
Date	getCreationDate() Return the creation date for the discovery analysis report that will result from this discovery request.
String	getDiscoveryReportGUID() Return the report identifier for this discovery context.
String	getReportDescription() Return the description for the discovery analysis report that will result from this discovery request.
String	getReportDisplayName() Return the display name of the discovery analysis report that will result from this discovery request.
String	getReportQualifiedName() Return the unique name of the discovery analysis report that will result from this discovery request.
List<String>	getRequestedAnnotationTypes() Return the list of annotation types required by the requester (null means all types available)
int	hashCode() Create a hash code for this element type.
void	setReportDescription(String reportDescription) Set up the description for the discovery analysis report that will result from this discovery request.
void	setReportDisplayName(String reportName) Set up the display name of the discovery analysis report that will result from this discovery request.
void	setReportQualifiedName(String reportName) Set up the unique name of the discovery analysis report that will result from this discovery request.
String	toString() Standard toString method.

Methods inherited from class java.lang.Object

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

Field Detail

userId

protected String userId

assetGUID

protected String assetGUID

discoveryReportGUID

protected String discoveryReportGUID

analysisParameters

protected Map<String,String> analysisParameters

requestedAnnotationTypes

protected List<String> requestedAnnotationTypes

assetStore

protected DiscoveryAssetStore assetStore

annotationStore

protected DiscoveryAnnotationStore annotationStore

creationDate

protected Date creationDate

reportQualifiedName

protected String reportQualifiedName

reportDisplayName

protected String reportDisplayName

reportDescription

protected String reportDescription

Constructor Detail

DiscoveryContext

public DiscoveryContext(String userId,
                        String assetGUID,
                        String discoveryReportGUID,
                        Map<String,String> analysisParameters,
                        List<String> requestedAnnotationTypes,
                        DiscoveryAssetStore assetStore,
                        DiscoveryAnnotationStore annotationStore)

Constructor sets up the key parameters for accessing the annotations store.

Parameters:

userId - calling user

assetGUID - unique identifier of the asset that the annotations should be attached to

discoveryReportGUID - unique identifier of the discovery request that is used to identifier the discovery report.

analysisParameters - name-value properties to control the discovery service

requestedAnnotationTypes - annotation types to create

assetStore - discovery asset store for the discovery service

annotationStore - annotation store for the discovery service

DiscoveryContext

public DiscoveryContext(DiscoveryContext template)

Copy/clone Constructor

Parameters:

template - object being copied

Method Detail

getAssetGUID

public String getAssetGUID()

Return the unique identifier of the asset being discovered.

Returns:

string guid

getDiscoveryReportGUID

public String getDiscoveryReportGUID()

Return the report identifier for this discovery context. Any new annotations added to tis discovery context will be linked to this report.

Returns:

unique identifier (guid) of the new discovery report.

getAnalysisParameters

public Map<String,String> getAnalysisParameters()

Return the properties that hold the parameters used to drive the discovery service's analysis.

Returns:

AdditionalProperties object storing the analysis parameters

getRequestedAnnotationTypes

public List<String> getRequestedAnnotationTypes()

Return the list of annotation types required by the requester (null means all types available)

Returns:

list of type names

getAssetStore

public DiscoveryAssetStore getAssetStore()

Return the asset store for the discovery engine. This is able to provide a connector to the asset configured with the properties of the asset from a property server.

Returns:

asset store

getAnnotationStore

public DiscoveryAnnotationStore getAnnotationStore()

Return the annotation store for the discovery engine. This is where the annotations are stored and retrieved from.

Returns:

annotation store

getCreationDate

public Date getCreationDate()

Return the creation date for the discovery analysis report that will result from this discovery request.

Returns:

Date that the report was created.

getReportQualifiedName

public String getReportQualifiedName()

Return the unique name of the discovery analysis report that will result from this discovery request.

Returns:

String report name

setReportQualifiedName

public void setReportQualifiedName(String reportName)

Set up the unique name of the discovery analysis report that will result from this discovery request. The discovery engine will set up a default fully-qualified name. This method enables it to be over-ridden.

Parameters:

reportName - String report name

getReportDisplayName

public String getReportDisplayName()

Return the display name of the discovery analysis report that will result from this discovery request.

Returns:

String report name

setReportDisplayName

public void setReportDisplayName(String reportName)

Set up the display name of the discovery analysis report that will result from this discovery request. The default name is null.

Parameters:

reportName - String report name

getReportDescription

public String getReportDescription()

Return the description for the discovery analysis report that will result from this discovery request. The default value is null.

Returns:

String report description

setReportDescription

public void setReportDescription(String reportDescription)

Set up the description for the discovery analysis report that will result from this discovery request.

Parameters:

reportDescription - String report description

toString

public String toString()

Standard toString method.

Overrides:

toString in class Object

Returns:

print out of variables in a JSON-style

equals

public boolean equals(Object objectToCompare)

Compare the values of the supplied object with those stored in the current object.

Overrides:

equals in class Object

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison

hashCode

public int hashCode()

Create a hash code for this element type.

Overrides:

hashCode in class Object

Returns:

int hash code