org.odpi.openmetadata.frameworks.discovery.properties

Class DiscoveryAnalysisReport

java.lang.Object

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

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

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

org.odpi.openmetadata.frameworks.discovery.properties.DiscoveryAnalysisReport

All Implemented Interfaces:

Serializable

public class DiscoveryAnalysisReport
extends Referenceable

DiscoveryAnalysisReport describes the header information for a discovery report

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	analysisParameters
protected String	assetGUID
protected Date	creationDate
protected String	description
protected String	discoveryEngineGUID
protected DiscoveryRequestStatus	discoveryRequestStatus
protected String	discoveryServiceGUID
protected String	displayName

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable

additionalProperties, meanings, qualifiedName

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader

classifications, extendedProperties, guid, type, url

Constructor Summary

Constructors

Constructor and Description
DiscoveryAnalysisReport() Default constructor
DiscoveryAnalysisReport(DiscoveryAnalysisReport template) Copy/clone constructor

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 parameters used to drive the discovery service's analysis.
String	getAssetGUID() Return the unique identifier of the asset that was analyzed.
Date	getCreationDate() Return the creation date for the report.
String	getDescription() Return the discovery analysis report description.
String	getDiscoveryEngineGUID() Return the unique identifier of the discovery engine that ran the discovery service.
DiscoveryRequestStatus	getDiscoveryRequestStatus() Return the status of the discovery process.
String	getDiscoveryServiceGUID() Return the unique identifier of the discovery service.
String	getDisplayName() Return the display name of the discovery analysis report.
int	hashCode() Create a hash code for this element type.
void	setAnalysisParameters(Map<String,String> analysisParameters) Set up the parameters used to drive the discovery service's analysis.
void	setAssetGUID(String assetGUID) Set up the unique identifier of the asset that was analyzed.
void	setCreationDate(Date creationDate) Set up the creation date for the report.
void	setDescription(String reportDescription) Set up the discovery analysis report description.
void	setDiscoveryEngineGUID(String discoveryEngineGUID) Set up the unique identifier of the discovery engine that ran the discovery service.
void	setDiscoveryRequestStatus(DiscoveryRequestStatus discoveryRequestStatus) Set up the status of the discovery process.
void	setDiscoveryServiceGUID(String discoveryServiceGUID) Set up the unique identifier of the discovery service.
void	setDisplayName(String reportName) Set up the display name of the discovery analysis report.
String	toString() Standard toString method.

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable

getAdditionalProperties, getMeanings, getQualifiedName, setAdditionalProperties, setMeanings, setQualifiedName

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader

getClassifications, getExtendedProperties, getGUID, getType, getURL, setClassifications, setExtendedProperties, setGUID, setType, setURL

Methods inherited from class java.lang.Object

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

Field Detail

displayName

protected String displayName

description

protected String description

creationDate

protected Date creationDate

analysisParameters

protected Map<String,String> analysisParameters

discoveryRequestStatus

protected DiscoveryRequestStatus discoveryRequestStatus

assetGUID

protected String assetGUID

discoveryEngineGUID

protected String discoveryEngineGUID

discoveryServiceGUID

protected String discoveryServiceGUID

Constructor Detail

DiscoveryAnalysisReport

public DiscoveryAnalysisReport()

Default constructor

DiscoveryAnalysisReport

public DiscoveryAnalysisReport(DiscoveryAnalysisReport template)

Copy/clone constructor

Parameters:

template - object to copy

Method Detail

getDisplayName

public String getDisplayName()

Return the display name of the discovery analysis report.

Returns:

String report name

setDisplayName

public void setDisplayName(String reportName)

Set up the display name of the discovery analysis report.

Parameters:

reportName - String report name

getDescription

public String getDescription()

Return the discovery analysis report description.

Returns:

String report description

setDescription

public void setDescription(String reportDescription)

Set up the discovery analysis report description.

Parameters:

reportDescription - String report description

getCreationDate

public Date getCreationDate()

Return the creation date for the report. If this date is not known then null is returned.

Returns:

Date that the report was created.

setCreationDate

public void setCreationDate(Date creationDate)

Set up the creation date for the report. If this date is not known then null is returned.

Parameters:

creationDate - Date that the report was created.

getAnalysisParameters

public Map<String,String> getAnalysisParameters()

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

Returns:

map storing the analysis parameters

setAnalysisParameters

public void setAnalysisParameters(Map<String,String> analysisParameters)

Set up the parameters used to drive the discovery service's analysis.

Parameters:

analysisParameters - map storing the analysis parameters

getDiscoveryRequestStatus

public DiscoveryRequestStatus getDiscoveryRequestStatus()

Return the status of the discovery process.

Returns:

status enum

setDiscoveryRequestStatus

public void setDiscoveryRequestStatus(DiscoveryRequestStatus discoveryRequestStatus)

Set up the status of the discovery process.

Parameters:

discoveryRequestStatus - status enum

getAssetGUID

public String getAssetGUID()

Return the unique identifier of the asset that was analyzed.

Returns:

unique identifier (guid)

setAssetGUID

public void setAssetGUID(String assetGUID)

Set up the unique identifier of the asset that was analyzed.

Parameters:

assetGUID - unique identifier (guid)

getDiscoveryEngineGUID

public String getDiscoveryEngineGUID()

Return the unique identifier of the discovery engine that ran the discovery service.

Returns:

unique identifier (guid)

setDiscoveryEngineGUID

public void setDiscoveryEngineGUID(String discoveryEngineGUID)

Set up the unique identifier of the discovery engine that ran the discovery service.

Parameters:

discoveryEngineGUID - unique identifier (guid)

getDiscoveryServiceGUID

public String getDiscoveryServiceGUID()

Return the unique identifier of the discovery service.

Returns:

unique identifier (guid)

setDiscoveryServiceGUID

public void setDiscoveryServiceGUID(String discoveryServiceGUID)

Set up the unique identifier of the discovery service.

Parameters:

discoveryServiceGUID - unique identifier (guid)

toString

public String toString()

Standard toString method.

Overrides:

toString in class Referenceable

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 Referenceable

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 Referenceable

Returns:

int hash code