Package org.odpi.openmetadata.frameworks.discovery.properties

Class DiscoveryAnalysisReport

  • All Implemented Interfaces:
    Serializable
    public class DiscoveryAnalysisReport
extends PropertyBase
    DiscoveryAnalysisReport describes the properties for a discovery analysis report.
    See Also:
    Serialized Form

    • Constructor Detail

      • DiscoveryAnalysisReport

        public DiscoveryAnalysisReport()
        Default constructor

      • DiscoveryAnalysisReport

        public DiscoveryAnalysisReport​(DiscoveryAnalysisReport template)
        Copy/clone constructor
        Parameters:
        template - object to copy

    • Method Detail

      • setQualifiedName

        public void setQualifiedName​(String qualifiedName)
        Set up the fully qualified name.
        Parameters:
        qualifiedName - String name

      • getQualifiedName

        public String getQualifiedName()
        Returns the stored qualified name property for the metadata entity. If no qualified name is available then the empty string is returned.
        Returns:
        qualifiedName

      • setAdditionalProperties

        public void setAdditionalProperties​(Map<String,​String> additionalProperties)
        Set up additional properties.
        Parameters:
        additionalProperties - Additional properties object

      • getAdditionalProperties

        public Map<String,​String> getAdditionalProperties()
        Return a copy of the additional properties. Null means no additional properties are available.
        Returns:
        AdditionalProperties

      • 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)

      • getAnalysisStep

        public String getAnalysisStep()
        Return the locally defined analysis step. This value is used in annotations generated in this phase.
        Returns:
        name of analysis step

      • setAnalysisStep

        public void setAnalysisStep​(String analysisStep)
        Set up the name of the current analysis step.
        Parameters:
        analysisStep - name

      • 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