org.odpi.openmetadata.frameworks.connectors.properties

Class AssetRating

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyElementBase

org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyBase

org.odpi.openmetadata.frameworks.connectors.properties.AssetElementHeader

org.odpi.openmetadata.frameworks.connectors.properties.AssetRating

All Implemented Interfaces:

Serializable

public class AssetRating
extends AssetElementHeader

Stores information about a rating connected to an asset. Ratings provide informal feedback on the quality of assets and can be added at any time. Ratings have the userId of the person who added it, a star rating and an optional review comment. The content of the rating is a personal judgement (which is why the user's id is in the object) and there is no formal review of the ratings. However, they can be used as a basis for crowd-sourcing feedback to asset owners.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Rating	ratingBean

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyBase

parentAsset

Constructor Summary

Constructors

Constructor and Description
AssetRating(AssetDescriptor parentAsset, AssetRating templateRating) Copy/clone constructor.
AssetRating(AssetDescriptor parentAsset, Rating ratingBean) Bean constructor with parent asset
AssetRating(Rating ratingBean) Bean 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.
protected Rating	getRatingBean() Return the bean with all of the properties.
String	getReview() Return the review comments - null means no review is available.
StarRating	getStarRating() Return the stars for the rating.
String	getUser() Return the user id of the person who created the rating.
int	hashCode() Hash of properties
boolean	isPublic() Return if this rating is private to the creating user.
String	toString() Standard toString method.

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetElementHeader

getAssetClassifications, getElementHeaderBean, getExtendedProperties, getGUID, getType, getURL, setBean

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyBase

getParentAsset, getParentAssetName, getParentAssetTypeName

Methods inherited from class java.lang.Object

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

Field Detail

ratingBean

protected Rating ratingBean

Constructor Detail

AssetRating

public AssetRating(Rating ratingBean)

Bean constructor

Parameters:

ratingBean - bean containing all of the properties

AssetRating

public AssetRating(AssetDescriptor parentAsset,
                   Rating ratingBean)

Bean constructor with parent asset

Parameters:

parentAsset - descriptor for parent asset

ratingBean - bean containing all of the properties

AssetRating

public AssetRating(AssetDescriptor parentAsset,
                   AssetRating templateRating)

Copy/clone constructor.

Parameters:

parentAsset - descriptor for parent asset

templateRating - element to copy

Method Detail

getRatingBean

protected Rating getRatingBean()

Return the bean with all of the properties.

Returns:

rating bean

isPublic

public boolean isPublic()

Return if this rating is private to the creating user.

Returns:

boolean

getUser

public String getUser()

Return the user id of the person who created the rating. Null means the user id is not known.

Returns:

String user

getStarRating

public StarRating getStarRating()

Return the stars for the rating.

Returns:

StarRating starRating

getReview

public String getReview()

Return the review comments - null means no review is available.

Returns:

String review comments

toString

public String toString()

Standard toString method.

Overrides:

toString in class AssetElementHeader

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 AssetElementHeader

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison

hashCode

public int hashCode()

Hash of properties

Overrides:

hashCode in class AssetElementHeader

Returns:

int