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

Class Model.ModelBuilder<C extends Model,B extends Model.ModelBuilder<C,B>>

java.lang.Object
gov.niem.tools.api.db.base.BaseEntity.BaseEntityBuilder<C,B>
gov.niem.tools.api.db.base.BaseStewardEntity.BaseStewardEntityBuilder<C,B>
gov.niem.tools.api.db.model.Model.ModelBuilder<C,B>
Enclosing class:
Model
public abstract static class Model.ModelBuilder<C extends Model,B extends Model.ModelBuilder<C,B>> extends BaseStewardEntity.BaseStewardEntityBuilder<C,B>

  • Constructor Details

    • ModelBuilder

      public ModelBuilder()

  • Method Details

    • steward

      public B steward(Steward steward)
      A steward responsible for the management of the model.
      Returns:
      this.

    • modelKey

      public B modelKey(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.
      Returns:
      this.

    • shortName

      public B shortName(String shortName)
      A short name or acronym used to identify a model.
      Returns:
      this.

    • fullName

      public B fullName(String fullName)
      A full name used to identify a model.
      Returns:
      this.

    • description

      public B description(String description)
      A description of a model.
      Returns:
      this.

    • website

      public B website(String website)
      A website address by which a person or organization may be contacted.
      Returns:
      this.

    • repo

      public B repo(String repo)
      A code repository which hosts full IEPDs or message specifications representing the model.
      Returns:
      this.

    • keywords

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

    • subjects

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

    • purpose

      public B purpose(String purpose)
      A description of the intended usage and reason for which an IEPD exists.
      Returns:
      this.

    • developer

      public B developer(String developer)
      A name of an organization or person that developed a model.
      Returns:
      this.

    • category

      public B category(Model.Category category)
      A kind of data model.
      Returns:
      this.

    • objective

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

    • versions

      public B versions(Set<Version> versions)
      A set of versions defined by a model.
      Returns:
      this.

    • self

      protected abstract B self()
      Specified by:
      self in class BaseStewardEntity.BaseStewardEntityBuilder<C extends Model,B extends Model.ModelBuilder<C,B>>

    • build

      public abstract C build()
      Specified by:
      build in class BaseStewardEntity.BaseStewardEntityBuilder<C extends Model,B extends Model.ModelBuilder<C,B>>

    • toString

      public String toString()
      Overrides:
      toString in class BaseStewardEntity.BaseStewardEntityBuilder<C extends Model,B extends Model.ModelBuilder<C,B>>