Package gov.niem.tools.api.db.steward

Class Steward

java.lang.Object
gov.niem.tools.api.db.base.BaseEntity
gov.niem.tools.api.db.steward.Steward
All Implemented Interfaces:
Serializable, Comparable<Steward>
@Entity @Indexed public class Steward extends BaseEntity implements Comparable<Steward>
A program, group, or other entity responsible for managing NIEM content.
See Also:

  • Field Details

  • Constructor Details

    • Steward

      public Steward(String shortName, String longName)

  • Method Details

    • getParentEntity

      public BaseEntity getParentEntity()
      Description copied from class: BaseEntity
      An immediate entity or scope to which this entity belongs. Examples include a steward (parent) for a model or a namespace (parent) for a property or type.
      Specified by:
      getParentEntity in class BaseEntity

    • getRoute

      public String getRoute()
      Description copied from class: BaseEntity
      An endpoint to get information about an entity.
      Specified by:
      getRoute in class BaseEntity

    • getClassName

      public String getClassName()
      Description copied from class: BaseEntity
      A kind of NIEM entity, such as a Namespace or a Property.
      Overrides:
      getClassName in class BaseEntity

    • getIdLabel

      public String getIdLabel()
      Description copied from class: BaseEntity
      A human-readable and url-friendly unique identifier for an entity.
      Specified by:
      getIdLabel in class BaseEntity

    • getIdLocalLabel

      public String getIdLocalLabel()
      Description copied from class: BaseEntity
      An identifier, unique within its immediate scope. Examples include a prefix (uniquely identifying a namespace) or a qualified name (uniquely identifying a property or a type) within a version of a model.
      Specified by:
      getIdLocalLabel in class BaseEntity

    • getTitle

      public String getTitle()
      Description copied from class: BaseEntity
      A descriptive label or title used to identify an entity.
      Specified by:
      getTitle in class BaseEntity

    • getNiemRoute

      public String getNiemRoute()
      Route to the NIEM steward.

    • getModelOptional

      public Optional<Model> getModelOptional(String modelKey)
      Get a model belonging to the steward with the given model key.

    • toSummary

      public Map<String,String> toSummary()
      Get key fields about a steward.

    • getModels

      public List<Model> getModels()
      Gets a sorted list of models that are under the authority of this steward. Makes sure potential Hibernate proxies are initialized.

    • compareTo

      public int compareTo(Steward other)
      Custom sorting function for stewards. Return the NIEM steward first, followed by stewards sorted by steward key.
      Specified by:
      compareTo in interface Comparable<Steward>