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

Class BaseEntity

java.lang.Object
gov.niem.tools.api.db.base.BaseEntity
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
BaseStewardEntity, Steward
@MappedSuperclass public abstract class BaseEntity extends Object implements Serializable
A parent class for all kinds of entities used to represent the structure of a NIEM model.
See Also:

  • Constructor Details

    • BaseEntity

      protected BaseEntity(BaseEntity.BaseEntityBuilder<?,?> b)

    • BaseEntity

      public BaseEntity()

    • BaseEntity

      public BaseEntity(Long id, String createdBy, LocalDateTime createdDate, String lastModifiedBy, LocalDateTime lastModifiedDate)
      Creates a new BaseEntity instance.
      Parameters:
      id - A unique, auto-generated identifier for an entity.
      createdBy - A user which created an entity.
      createdDate - A date on which an entity was created.
      lastModifiedBy - A user which last updated an entity.
      lastModifiedDate - A date on which an entity was last updated.

  • Method Details

    • getFullIdentifier

      public abstract String getFullIdentifier()
      A human-readable and url-friendly unique identifier for an entity.

    • getLocalIdentifier

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

    • getClassName

      public String getClassName()
      A kind of NIEM entity, such as a Namespace or a Property.

    • getRoute

      public abstract String getRoute()
      An endpoint to get information about an entity.

    • getTitle

      public abstract String getTitle()
      A descriptive label or title used to identify an entity.

    • getParentEntity

      public abstract BaseEntity getParentEntity()
      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.

    • getId

      public Long getId()
      A unique, auto-generated identifier for an entity.

    • getCreatedBy

      public String getCreatedBy()
      A user which created an entity.

    • getCreatedDate

      public LocalDateTime getCreatedDate()
      A date on which an entity was created.

    • getLastModifiedBy

      public String getLastModifiedBy()
      A user which last updated an entity.

    • getLastModifiedDate

      public LocalDateTime getLastModifiedDate()
      A date on which an entity was last updated.

    • setId

      public void setId(Long id)
      A unique, auto-generated identifier for an entity.

    • setCreatedBy

      public void setCreatedBy(String createdBy)
      A user which created an entity.

    • setCreatedDate

      public void setCreatedDate(LocalDateTime createdDate)
      A date on which an entity was created.

    • setLastModifiedBy

      public void setLastModifiedBy(String lastModifiedBy)
      A user which last updated an entity.

    • setLastModifiedDate

      public void setLastModifiedDate(LocalDateTime lastModifiedDate)
      A date on which an entity was last updated.

    • equals

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

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object