Package org.odpi.openmetadata.frameworks.connectors.properties.beans

Class Rating

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementControlHeader
org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementHeader
org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementBase
org.odpi.openmetadata.frameworks.connectors.properties.beans.Rating
public class Rating extends ElementBase
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.

  • Field Summary

    Fields inherited from class org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementControlHeader

    CURRENT_AUDIT_HEADER_VERSION

  • Constructor Summary

    Constructors
    Constructor
    Description
    Rating()
    Default constructor
    Rating(Rating template)
    Copy/clone constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object objectToCompare)
    Compare the values of the supplied object with those stored in the current object.
    boolean
    getIsPublic()
    Return if this rating is private ot the creating user.
    String
    getReview()
    Return the review comments - null means no review is available.
    org.odpi.openmetadata.frameworks.openmetadata.enums.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
    void
    setIsPublic(boolean aPublic)
    Set up whether the rating is private to the creating user or not.
    void
    setReview(String review)
    Set up the review comments - null means no review is available.
    void
    setStarRating(org.odpi.openmetadata.frameworks.openmetadata.enums.StarRating starRating)
    Set up the stars for the rating.
    void
    setUser(String user)
    Set up the user id of the person who created the rating.
    String
    toString()
    Standard toString method.

    Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementBase

    getExtendedProperties, setExtendedProperties

    Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementHeader

    getClassifications, getGUID, setClassifications, setGUID

    Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementControlHeader

    getHeaderVersion, getOrigin, getStatus, getType, getVersions, setHeaderVersion, setOrigin, setStatus, setType, setVersions

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Rating

      public Rating()
      Default constructor

    • Rating

      public Rating(Rating template)
      Copy/clone constructor.
      Parameters:
      template - element to copy

  • Method Details

    • 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

    • setUser

      public void setUser(String user)
      Set up the user id of the person who created the rating. Null means the user id is not known.
      Parameters:
      user - string

    • getStarRating

      public org.odpi.openmetadata.frameworks.openmetadata.enums.StarRating getStarRating()
      Return the stars for the rating.
      Returns:
      StarRating enum

    • setStarRating

      public void setStarRating(org.odpi.openmetadata.frameworks.openmetadata.enums.StarRating starRating)
      Set up the stars for the rating.
      Parameters:
      starRating - StarRating enum

    • getReview

      public String getReview()
      Return the review comments - null means no review is available.
      Returns:
      String review comments

    • setReview

      public void setReview(String review)
      Set up the review comments - null means no review is available.
      Parameters:
      review - String review comments

    • getIsPublic

      public boolean getIsPublic()
      Return if this rating is private ot the creating user.
      Returns:
      boolean

    • setIsPublic

      public void setIsPublic(boolean aPublic)
      Set up whether the rating is private to the creating user or not.
      Parameters:
      aPublic - boolean

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class ElementBase
      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 ElementBase
      Parameters:
      objectToCompare - supplied object
      Returns:
      boolean result of comparison

    • hashCode

      public int hashCode()
      Hash of properties
      Overrides:
      hashCode in class ElementBase
      Returns:
      int