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
@Entity @Indexed public class Steward extends BaseEntity
A program, group, or other entity responsible for managing NIEM content.
See Also:

  • Field Details

  • Constructor Details

    • Steward

      public Steward(String shortName, String longName)

    • Steward

      protected Steward(Steward.StewardBuilder<?,?> b)

    • Steward

      public Steward()

    • Steward

      public Steward(String stewardKey, String shortName, String fullName, Steward.Category category, String description, String contactName, String website, String email, String phone, String address, CountryAlpha3CodeType country, String unit, String subunit, Set<Model> models)
      Creates a new Steward instance.
      Parameters:
      stewardKey - A human-readable and url-friendly steward identifier generated from the shortName field.
      shortName - A short name or acronym used to identify a steward. This could be the name of an organization or unit, a program name, or other kind of authoritative source.
      fullName - A name of an organization.
      category - A kind of steward.
      description - A description of an organization.
      contactName - A name of the person to be contacted.
      website - A website address by which a person or organization may be contacted.
      email - An electronic mailing address by which a person or organization may be contacted.
      phone - A complete telephone number.
      address - A complete address.
      country - A country, territory, dependency, or other such geopolitical subdivision of a location.
      unit - A name of a high-level division of an organization.
      subunit - A name of a subdivision of an organization.
      models - A set of models which belong to the steward.

  • 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

    • getFullIdentifier

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

    • getLocalIdentifier

      public String getLocalIdentifier()
      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:
      getLocalIdentifier 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.

    • builder

      public static Steward.StewardBuilder<?,?> builder()

    • getStewardKey

      public String getStewardKey()
      A human-readable and url-friendly steward identifier generated from the shortName field.

    • getShortName

      public String getShortName()
      A short name or acronym used to identify a steward. This could be the name of an organization or unit, a program name, or other kind of authoritative source.

    • getFullName

      public String getFullName()
      A name of an organization.

    • getCategory

      public Steward.Category getCategory()
      A kind of steward.

    • getDescription

      public String getDescription()
      A description of an organization.

    • getContactName

      public String getContactName()
      A name of the person to be contacted.

    • getWebsite

      public String getWebsite()
      A website address by which a person or organization may be contacted.

    • getEmail

      public String getEmail()
      An electronic mailing address by which a person or organization may be contacted.

    • getPhone

      public String getPhone()
      A complete telephone number.

    • getAddress

      public String getAddress()
      A complete address.

    • getCountry

      public CountryAlpha3CodeType getCountry()
      A country, territory, dependency, or other such geopolitical subdivision of a location.

    • getUnit

      public String getUnit()
      A name of a high-level division of an organization.

    • getSubunit

      public String getSubunit()
      A name of a subdivision of an organization.

    • getModels

      public Set<Model> getModels()
      A set of models which belong to the steward.

    • setStewardKey

      public void setStewardKey(String stewardKey)
      A human-readable and url-friendly steward identifier generated from the shortName field.

    • setShortName

      public void setShortName(String shortName)
      A short name or acronym used to identify a steward. This could be the name of an organization or unit, a program name, or other kind of authoritative source.

    • setFullName

      public void setFullName(String fullName)
      A name of an organization.

    • setCategory

      public void setCategory(Steward.Category category)
      A kind of steward.

    • setDescription

      public void setDescription(String description)
      A description of an organization.

    • setContactName

      public void setContactName(String contactName)
      A name of the person to be contacted.

    • setWebsite

      public void setWebsite(String website)
      A website address by which a person or organization may be contacted.

    • setEmail

      public void setEmail(String email)
      An electronic mailing address by which a person or organization may be contacted.

    • setPhone

      public void setPhone(String phone)
      A complete telephone number.

    • setAddress

      public void setAddress(String address)
      A complete address.

    • setCountry

      public void setCountry(CountryAlpha3CodeType country)
      A country, territory, dependency, or other such geopolitical subdivision of a location.

    • setUnit

      public void setUnit(String unit)
      A name of a high-level division of an organization.

    • setSubunit

      public void setSubunit(String subunit)
      A name of a subdivision of an organization.

    • setModels

      public void setModels(Set<Model> models)
      A set of models which belong to the steward.

    • toString

      public String toString()
      Overrides:
      toString in class BaseEntity

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class BaseEntity

    • canEqual

      protected boolean canEqual(Object other)
      Overrides:
      canEqual in class BaseEntity

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class BaseEntity