Class AssetProperties
java.lang.Object
org.odpi.openmetadata.accessservices.assetowner.properties.ReferenceableProperties
org.odpi.openmetadata.accessservices.assetowner.properties.SupplementaryProperties
org.odpi.openmetadata.accessservices.assetowner.properties.AssetProperties
- Direct Known Subclasses:
DataStoreProperties
AssetProperties holds asset properties that are used for displaying details of
an asset in summary lists or hover text. It includes the following properties:
- type - metadata type information for the asset
- guid - globally unique identifier for the asset
- url - external link for the asset
- qualifiedName - The official (unique) name for the asset. This is often defined by the IT systems management organization and should be used (when available) on audit logs and error messages. (qualifiedName from Referenceable - model 0010)
- displayName - A consumable name for the asset. Often a shortened form of the assetQualifiedName for use on user interfaces and messages. The assetDisplayName should only be used for audit logs and error messages if the assetQualifiedName is not set. (Sourced from attribute name within Asset - model 0010)
- shortDescription - short description about the asset. (Sourced from assetSummary within ConnectionsToAsset - model 0205)
- description - full description of the asset. (Sourced from attribute description within Asset - model 0010)
- classifications - list of all classifications assigned to the asset
- extendedProperties - list of properties assigned to the asset from the Asset subclasses
- additionalProperties - list of properties assigned to the asset as additional properties
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructorAssetProperties(AssetProperties template) Copy/clone constructor. -
Method Summary
Modifier and TypeMethodDescriptionbooleanCompare the values of the supplied object with those stored in the current object.Returns the stored description property for the asset.getName()Return the name of the resource that this asset represents.Set up the version identifier of the resource.inthashCode()Return hash code based on properties.voidsetDescription(String description) Set up the stored description property associated with the asset.voidSet up the name of the resource that this asset represents.voidsetVersionIdentifier(String versionIdentifier) Set up the version identifier of the resource.toString()Standard toString method.Methods inherited from class org.odpi.openmetadata.accessservices.assetowner.properties.SupplementaryProperties
getAbbreviation, getDisplayDescription, getDisplayName, getDisplaySummary, getUsage, setAbbreviation, setDisplayDescription, setDisplayName, setDisplaySummary, setUsageMethods inherited from class org.odpi.openmetadata.accessservices.assetowner.properties.ReferenceableProperties
getAdditionalProperties, getEffectiveFrom, getEffectiveTo, getExtendedProperties, getQualifiedName, getTypeName, setAdditionalProperties, setEffectiveFrom, setEffectiveTo, setExtendedProperties, setQualifiedName, setTypeName
-
Constructor Details
-
AssetProperties
public AssetProperties()Default constructor -
AssetProperties
Copy/clone constructor. Note, this is a deep copy- Parameters:
template- object to copy
-
-
Method Details
-
getName
Return the name of the resource that this asset represents.- Returns:
- string resource name
-
setName
Set up the name of the resource that this asset represents.- Parameters:
name- string resource name
-
getVersionIdentifier
Set up the version identifier of the resource.- Returns:
- string version name
-
setVersionIdentifier
Set up the version identifier of the resource.- Parameters:
versionIdentifier- string version name
-
getDescription
Returns the stored description property for the asset. If no description is provided then null is returned.- Returns:
- description String text
-
setDescription
Set up the stored description property associated with the asset.- Parameters:
description- String text
-
toString
Standard toString method.- Overrides:
toStringin classSupplementaryProperties- 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:
equalsin classSupplementaryProperties- Parameters:
objectToCompare- supplied object- Returns:
- boolean result of comparison
-
hashCode
public int hashCode()Return hash code based on properties.- Overrides:
hashCodein classSupplementaryProperties- Returns:
- int
-