Class ExternalIdentifier
java.lang.Object
org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase
org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementControlHeader
org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader
org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementBase
org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable
org.odpi.openmetadata.frameworks.connectors.properties.beans.ExternalIdentifier
- All Implemented Interfaces:
Serializable
ExternalIdentifier stores information about an identifier for the asset that is used in an external system.
This is used for correlating information about the asset across different systems.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected String
protected String
protected KeyPattern
protected Referenceable
protected String
protected String
protected String
Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable
additionalProperties, qualifiedName
Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementBase
extendedProperties, url
Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase
CURRENT_AUDIT_HEADER_VERSION
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructorExternalIdentifier
(ExternalIdentifier templateExternalIdentifier) Copy/clone constructor. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Compare the values of the supplied object with those stored in the current object.Return the description of the external identifier.Return the external identifier for this asset.Return the key pattern that is used with this external identifier.getScope()
Return the scope of this external identifier.Return the text description of the scope for this external identifier.Return details of the source system where this external identifier comes from.getUsage()
Return a description of how, where and when this external identifier is used.int
hashCode()
Hash of propertiesvoid
setDescription
(String description) Set up the description of the external identifier.void
setIdentifier
(String identifier) Set up the external identifier for this asset.void
setKeyPattern
(KeyPattern keyPattern) Set up the key pattern that is used with this external identifier.void
setScope
(Referenceable scope) Set up the scope of this external identifier.void
setScopeDescription
(String scopeDescription) Set up the text description of the scope for this external identifier.void
Set up details of the source system where this external identifier comes from.void
Set up a description of how, where and when this external identifier is used.toString()
Standard toString method.Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable
getAdditionalProperties, getQualifiedName, setAdditionalProperties, setQualifiedName
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementBase
getExtendedProperties, getURL, setExtendedProperties, setURL
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader
getClassifications, getGUID, setClassifications, setGUID
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementControlHeader
getOrigin, getStatus, getType, getVersions, setOrigin, setStatus, setType, setVersions
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase
getHeaderVersion, setHeaderVersion
-
Field Details
-
identifier
-
description
-
usage
-
source
-
keyPattern
-
scope
-
scopeDescription
-
-
Constructor Details
-
ExternalIdentifier
public ExternalIdentifier()Default constructor -
ExternalIdentifier
Copy/clone constructor.- Parameters:
templateExternalIdentifier
- element to copy
-
-
Method Details
-
getIdentifier
Return the external identifier for this asset.- Returns:
- String identifier
-
setIdentifier
Set up the external identifier for this asset.- Parameters:
identifier
- String identifier
-
getDescription
Return the description of the external identifier.- Returns:
- String text
-
setDescription
Set up the description of the external identifier.- Parameters:
description
- String text
-
getUsage
Return a description of how, where and when this external identifier is used.- Returns:
- String usage description
-
setUsage
Set up a description of how, where and when this external identifier is used.- Parameters:
usage
- String usage description
-
getSource
Return details of the source system where this external identifier comes from.- Returns:
- String server identifier
-
setSource
Set up details of the source system where this external identifier comes from.- Parameters:
source
- String server identifier
-
getKeyPattern
Return the key pattern that is used with this external identifier.- Returns:
- KeyPattern enum
-
setKeyPattern
Set up the key pattern that is used with this external identifier.- Parameters:
keyPattern
- KeyPattern enum
-
getScope
Return the scope of this external identifier. This depends on the key pattern. It may be a server definition, a reference data set or glossary term.- Returns:
- Referenceable scope
-
setScope
Set up the scope of this external identifier. This depends on the key pattern. It may be a server definition, a reference data set or glossary term.- Parameters:
scope
- Referenceable object defining the scope of this external identifier.
-
getScopeDescription
Return the text description of the scope for this external identifier.- Returns:
- String scope description
-
setScopeDescription
Set up the text description of the scope for this external identifier.- Parameters:
scopeDescription
- String scope description
-
toString
Standard toString method.- Overrides:
toString
in classReferenceable
- Returns:
- print out of variables in a JSON-style
-
equals
Compare the values of the supplied object with those stored in the current object.- Overrides:
equals
in classReferenceable
- Parameters:
objectToCompare
- supplied object- Returns:
- boolean result of comparison
-
hashCode
public int hashCode()Hash of properties- Overrides:
hashCode
in classReferenceable
- Returns:
- int
-