Package gov.niem.tools.api.db.model

Class Model

java.lang.Object
gov.niem.tools.api.db.base.BaseEntity
gov.niem.tools.api.db.base.BaseStewardEntity
gov.niem.tools.api.db.model.Model
All Implemented Interfaces:
Serializable
@Entity @Indexed public class Model extends BaseStewardEntity
A reference or message data model.
See Also:

  • Field Details

  • Constructor Details

    • Model

      public Model(String shortName)
      Creates a model with the given fields.

    • Model

      public Model(String shortName, String longName, Model.Category category)
      Creates a model with the given fields.

    • Model

      public Model(String shortName, String longName, Steward steward, Model.Category category)
      Creates a model with the given fields.

    • Model

      protected Model(Model.ModelBuilder<?,?> b)

    • Model

      public Model()

    • Model

      public Model(Steward steward, String modelKey, String shortName, String fullName, String description, String website, String repo, String keywords, String subjects, String purpose, String developer, Model.Category category, Model.Objective objective, Set<Version> versions)
      Creates a new Model instance.
      Parameters:
      steward - A steward responsible for the management of the model.
      modelKey - A human-readable and url-friendly model identifier generated from the shortName field, unique within the set of models owned by its steward.
      shortName - A short name or acronym used to identify a model.
      fullName - A full name used to identify a model.
      description - A description of a model.
      website - A website address by which a person or organization may be contacted.
      repo - A code repository which hosts full IEPDs or message specifications representing the model.
      keywords - A common alias, term, or phrase that would help to facilitate search and discovery of this IEPD.
      subjects - A description of the environment or NIEM Domain in which this IEPD is applicable or used.
      purpose - A description of the intended usage and reason for which an IEPD exists.
      developer - A name of an organization or person that developed a model.
      category - A kind of data model.
      objective - An intended use for a model, such as for actual implementation or for testing tool features or IEPD / message specification features.
      versions - A set of versions defined by a model.

  • Method Details

    • getSteward

      public Steward getSteward()
      Gets the Steward responsible for this model. Makes sure a potential Hibernate proxy is initialized.
      Specified by:
      getSteward in class BaseStewardEntity

    • getParentEntity

      public Steward 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()
      Gets the API route to the NIEM model.

    • toSummary

      public Map<String,String> toSummary()
      Gets keys fields about the model.

    • builder

      public static Model.ModelBuilder<?,?> builder()

    • getModelKey

      public String getModelKey()
      A human-readable and url-friendly model identifier generated from the shortName field, unique within the set of models owned by its steward.

    • getShortName

      public String getShortName()
      A short name or acronym used to identify a model.

    • getFullName

      public String getFullName()
      A full name used to identify a model.

    • getDescription

      public String getDescription()
      A description of a model.

    • getWebsite

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

    • getRepo

      public String getRepo()
      A code repository which hosts full IEPDs or message specifications representing the model.

    • getKeywords

      public String getKeywords()
      A common alias, term, or phrase that would help to facilitate search and discovery of this IEPD.

    • getSubjects

      public String getSubjects()
      A description of the environment or NIEM Domain in which this IEPD is applicable or used.

    • getPurpose

      public String getPurpose()
      A description of the intended usage and reason for which an IEPD exists.

    • getDeveloper

      public String getDeveloper()
      A name of an organization or person that developed a model.

    • getCategory

      public Model.Category getCategory()
      A kind of data model.

    • getObjective

      public Model.Objective getObjective()
      An intended use for a model, such as for actual implementation or for testing tool features or IEPD / message specification features.

    • getVersions

      public Set<Version> getVersions()
      A set of versions defined by a model.

    • setSteward

      public void setSteward(Steward steward)
      A steward responsible for the management of the model.

    • setModelKey

      public void setModelKey(String modelKey)
      A human-readable and url-friendly model identifier generated from the shortName field, unique within the set of models owned by its steward.

    • setShortName

      public void setShortName(String shortName)
      A short name or acronym used to identify a model.

    • setFullName

      public void setFullName(String fullName)
      A full name used to identify a model.

    • setDescription

      public void setDescription(String description)
      A description of a model.

    • setWebsite

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

    • setRepo

      public void setRepo(String repo)
      A code repository which hosts full IEPDs or message specifications representing the model.

    • setKeywords

      public void setKeywords(String keywords)
      A common alias, term, or phrase that would help to facilitate search and discovery of this IEPD.

    • setSubjects

      public void setSubjects(String subjects)
      A description of the environment or NIEM Domain in which this IEPD is applicable or used.

    • setPurpose

      public void setPurpose(String purpose)
      A description of the intended usage and reason for which an IEPD exists.

    • setDeveloper

      public void setDeveloper(String developer)
      A name of an organization or person that developed a model.

    • setCategory

      public void setCategory(Model.Category category)
      A kind of data model.

    • setObjective

      public void setObjective(Model.Objective objective)
      An intended use for a model, such as for actual implementation or for testing tool features or IEPD / message specification features.

    • setVersions

      public void setVersions(Set<Version> versions)
      A set of versions defined by a model.

    • toString

      public String toString()
      Overrides:
      toString in class BaseStewardEntity

    • equals

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

    • canEqual

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class BaseStewardEntity