Package gov.niem.tools.api.db.base

Class BaseVersionEntity.BaseVersionEntityBuilder<T extends BaseVersionEntity<T>,C extends BaseVersionEntity<T>,B extends BaseVersionEntity.BaseVersionEntityBuilder<T,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.base.BaseModelEntity.BaseModelEntityBuilder<C,B>
gov.niem.tools.api.db.base.BaseVersionEntity.BaseVersionEntityBuilder<T,C,B>
Direct Known Subclasses:
BaseNamespaceEntity.BaseNamespaceEntityBuilder, Namespace.NamespaceBuilder
Enclosing class:
BaseVersionEntity<T extends BaseVersionEntity<T>>
public abstract static class BaseVersionEntity.BaseVersionEntityBuilder<T extends BaseVersionEntity<T>,C extends BaseVersionEntity<T>,B extends BaseVersionEntity.BaseVersionEntityBuilder<T,C,B>> extends BaseModelEntity.BaseModelEntityBuilder<C,B>

  • Constructor Details

    • BaseVersionEntityBuilder

      public BaseVersionEntityBuilder()

  • Method Details

    • prev

      public B prev(T prev)
      Corresponding entity mapped from the previous version.
      Returns:
      this.

    • next

      public B next(T next)
      Corresponding entity mapped from the next version.
      Returns:
      this.

    • original

      public B original(T original)
      For a subset that reuses content from another model, this is the link to the original entity. The value is null if this entity is actually defined by its version rather than reused from another model as part of a subset.

      Example 1: NIEM model 5.2 is the original source of property "nc:Person". In this case, this property is itself the original and has no other original source to point to. The value of original is null.

      Example 2: Acme Crash Driver 1.0 reuses property nc:Person from NIEM model 5.2 and is not its original source. The value of original is a reference to the NIEM model 5.2 nc:Person property.

      Although most information about an entity will be duplicated between the original and its usages via subsets, tracking the usages of each entity independently supports subset-approved customizations, like adjusted cardinality, custom namespace prefixes, property aliases, inlined substitutions, and flattened types.

      Returns:
      this.

    • isDeprecated

      public B isDeprecated(boolean isDeprecated)
      True if an entity is deprecated; false or null otherwise.
      Returns:
      this.

    • self

      protected abstract B self()
      Specified by:
      self in class BaseModelEntity.BaseModelEntityBuilder<C extends BaseVersionEntity<T>,B extends BaseVersionEntity.BaseVersionEntityBuilder<T,C,B>>

    • build

      public abstract C build()
      Specified by:
      build in class BaseModelEntity.BaseModelEntityBuilder<C extends BaseVersionEntity<T>,B extends BaseVersionEntity.BaseVersionEntityBuilder<T,C,B>>

    • toString

      public String toString()
      Overrides:
      toString in class BaseModelEntity.BaseModelEntityBuilder<C extends BaseVersionEntity<T>,B extends BaseVersionEntity.BaseVersionEntityBuilder<T,C,B>>