org.odpi.openmetadata.frameworks.discovery.properties

Class DiscoveryEngineProperties

java.lang.Object

org.odpi.openmetadata.frameworks.discovery.properties.PropertyBase

org.odpi.openmetadata.frameworks.discovery.properties.DiscoveryEngineProperties

All Implemented Interfaces:

Serializable

public class DiscoveryEngineProperties
extends PropertyBase

DiscoveryEngineProperties describe the properties needed to describe a specific discovery engine. These properties are augmented with a list of registered discovery services (see RegisteredDiscoveryService).

See Also:

Serialized Form

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.discovery.properties.PropertyBase

CURRENT_AUDIT_HEADER_VERSION

Constructor Summary

Constructors

Constructor and Description
DiscoveryEngineProperties() Default constructor.
DiscoveryEngineProperties(DiscoveryEngineProperties 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>	getAdditionalProperties() Return a copy of the additional properties.
String	getDescription() Return the description of the discovery engine.
String	getDisplayName() Return the display name for messages and UI.
String	getPatchLevel() Return the patch level of the discovery engine.
String	getQualifiedName() Returns the stored qualified name property for the metadata entity.
String	getSource() Return the source of the discovery engine implementation.
String	getTypeDescription() Return the description of the type of discovery engine this is.
String	getVersion() Return the version of the discovery engine.
int	hashCode() Create a hash code for this element type.
void	setAdditionalProperties(Map<String,String> additionalProperties) Set up additional properties.
void	setDescription(String description) Set up the description of the discovery engine.
void	setDisplayName(String displayName) Set up the display name for messages and UI.
void	setPatchLevel(String patchLevel) Set up the patch level of the discovery engine.
void	setQualifiedName(String qualifiedName) Set up the fully qualified name.
void	setSource(String source) Set up the source of the discovery engine implementation.
void	setTypeDescription(String typeDescription) Set up the description of the type of discovery engine this is.
void	setVersion(String version) Set up the version string of the discovery engine.
String	toString() Standard toString method.

Methods inherited from class org.odpi.openmetadata.frameworks.discovery.properties.PropertyBase

getElementHeader, getExtendedProperties, getHeaderVersion, getTypeName, setElementHeader, setExtendedProperties, setHeaderVersion, setTypeName

Methods inherited from class java.lang.Object

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

Constructor Detail

DiscoveryEngineProperties

public DiscoveryEngineProperties()

Default constructor.

DiscoveryEngineProperties

public DiscoveryEngineProperties(DiscoveryEngineProperties 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

getDisplayName

public String getDisplayName()

Return the display name for messages and UI.

Returns:

string name

setDisplayName

public void setDisplayName(String displayName)

Set up the display name for messages and UI.

Parameters:

displayName - string name

getDescription

public String getDescription()

Return the description of the discovery engine.

Returns:

string description

setDescription

public void setDescription(String description)

Set up the description of the discovery engine.

Parameters:

description - string

getTypeDescription

public String getTypeDescription()

Return the description of the type of discovery engine this is.

Returns:

string description

setTypeDescription

public void setTypeDescription(String typeDescription)

Set up the description of the type of discovery engine this is.

Parameters:

typeDescription - string

getVersion

public String getVersion()

Return the version of the discovery engine.

Returns:

version string

setVersion

public void setVersion(String version)

Set up the version string of the discovery engine.

Parameters:

version - string

getPatchLevel

public String getPatchLevel()

Return the patch level of the discovery engine.

Returns:

patch level string

setPatchLevel

public void setPatchLevel(String patchLevel)

Set up the patch level of the discovery engine.

Parameters:

patchLevel - string

getSource

public String getSource()

Return the source of the discovery engine implementation.

Returns:

string url

setSource

public void setSource(String source)

Set up the source of the discovery engine implementation.

Parameters:

source - string url

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

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