Package gov.niem.tools.api.db.component

Class Component<T extends BaseNamespaceEntity<T>>

java.lang.Object
gov.niem.tools.api.db.base.BaseEntity
gov.niem.tools.api.db.base.BaseStewardEntity
gov.niem.tools.api.db.base.BaseModelEntity
gov.niem.tools.api.db.base.BaseVersionEntity<T>
gov.niem.tools.api.db.base.BaseNamespaceEntity<T>
gov.niem.tools.api.db.component.Component<T>
Type Parameters:
T - - A subclass of Component, i.e., Property or Type.
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
Property, Type
@MappedSuperclass @Indexed public abstract class Component<T extends BaseNamespaceEntity<T>> extends BaseNamespaceEntity<T>
A parent class for Property and Type.
See Also:

  • Field Details

    • prefix

      protected String prefix
      A namespace prefix for the property or type.

    • qname

      public String qname

    • name

      @FullTextField(analyzer="camel") @FullTextField(name="name_substring",analyzer="substring") @KeywordField(name="name_keyword", sortable=YES, projectable=YES) protected String name
      A name of the property or type.

    • definition

      @FullTextField protected String definition
      A definition describing a property or type.

  • Constructor Details

    • Component

      protected Component(Component.ComponentBuilder<T,?,?> b)

    • Component

      public Component()

    • Component

      public Component(String prefix, String qname, String name, String definition, Namespace namespace)
      Creates a new Component instance.
      Parameters:
      prefix - A namespace prefix for the property or type.
      qname -
      name - A name of the property or type.
      definition - A definition describing a property or type.
      namespace - Namespace that defines this component.

  • Method Details

    • getCategory

      protected abstract Object getCategory()

    • getNamespace

      public Namespace getNamespace()
      Namespace that defines this component.
      Specified by:
      getNamespace in class BaseNamespaceEntity<T extends BaseNamespaceEntity<T>>

    • getParentEntity

      public Namespace 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

    • 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

    • getTerms

      public String[] getTerms()
      A set of terms from the name of the property or type, broken apart by camel casing.

    • toSummary

      public Map<String,String> toSummary()
      Returns key fields about a component.

    • getPrefix

      public static String getPrefix(String qname)
      Return the first part (namespace prefix) of a qualified name string with a ":" delimiter. For example, return "nc" given "nc:PersonBirthDate".

    • getName

      public static String getName(String qname)
      Return the second part (namespace prefix) of a qualified name string with a ":" delimiter. For example, return "PersonBirthDate" given "nc:PersonBirthDate".

    • toCmf

      public org.mitre.niem.cmf.Component toCmf() throws org.mitre.niem.cmf.CMFException
      Throws:
      org.mitre.niem.cmf.CMFException

    • getPrefix

      public String getPrefix()
      A namespace prefix for the property or type.

    • getQname

      public String getQname()

    • getName

      public String getName()
      A name of the property or type.

    • getDefinition

      public String getDefinition()
      A definition describing a property or type.

    • setPrefix

      public void setPrefix(String prefix)
      A namespace prefix for the property or type.

    • setQname

      public void setQname(String qname)

    • setName

      public void setName(String name)
      A name of the property or type.

    • setDefinition

      public void setDefinition(String definition)
      A definition describing a property or type.

    • setNamespace

      public void setNamespace(Namespace namespace)
      Namespace that defines this component.

    • toString

      public String toString()
      Overrides:
      toString in class BaseNamespaceEntity<T extends BaseNamespaceEntity<T>>

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class BaseNamespaceEntity<T extends BaseNamespaceEntity<T>>

    • canEqual

      protected boolean canEqual(Object other)
      Overrides:
      canEqual in class BaseNamespaceEntity<T extends BaseNamespaceEntity<T>>

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class BaseNamespaceEntity<T extends BaseNamespaceEntity<T>>