Package gov.niem.tools.api.db.subproperty

Class Subproperty

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<Subproperty>
gov.niem.tools.api.db.base.BaseNamespaceEntity<Subproperty>
gov.niem.tools.api.db.subproperty.Subproperty
All Implemented Interfaces:
BaseCmfEntity<org.mitre.niem.cmf.HasProperty>, Serializable
@Entity public class Subproperty extends BaseNamespaceEntity<Subproperty> implements BaseCmfEntity<org.mitre.niem.cmf.HasProperty>
A subproperty is a property that is contained by a type, along with cardinality constraints. Also called a child property association.
See Also:

  • Field Details

    • typeQname

      public String typeQname

    • propertyQname

      public String propertyQname

  • Constructor Details

    • Subproperty

      public Subproperty()

    • Subproperty

      public Subproperty(Type type, Property property, Long versionId, String min, String max, int sequence, @Nullable String definition, String typeQname, String propertyQname)
      Creates a new Subproperty instance.
      Parameters:
      type -
      property -
      versionId -
      min - Min cardinality 0 or 1-9 with zero or more additional digits.
      max - Max cardinality 'unbounded' or 1-9 with zero or more additional digits.
      sequence -
      definition -
      typeQname -
      propertyQname -

  • Method Details

    • getType

      public Type getType()
      Gets the type of this subproperty. Makes sure a potential Hibernate proxy is initialized.

    • getProperty

      public Property getProperty()
      Gets the property of this subproperty. Makes sure a potential Hibernate proxy is initialized.

    • getNamespace

      public Namespace getNamespace()
      Gets the namespace where this subproperty is defined (the type namespace).
      Specified by:
      getNamespace in class BaseNamespaceEntity<Subproperty>

    • getTypeQname

      public String getTypeQname()
      Gets the qualified name of this subproperty's type.

    • getTypePrefix

      public String getTypePrefix()
      Gets the namespace prefix of this subproperty's type.

    • getPropertyQname

      public String getPropertyQname()
      Gets the qualified name of this subproperty's property.

    • getPropertyPrefix

      public String getPropertyPrefix()
      Gets the namespace prefix of this subproperty's property.

    • getTypeSummary

      public Map<String,String> getTypeSummary()
      Gets summary fields about this subproperty's type.

    • getPropertySummary

      public Map<String,String> getPropertySummary()

    • getParentEntity

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

    • addToCmfModel

      public void addToCmfModel(org.mitre.niem.cmf.Model cmfModel) throws org.mitre.niem.cmf.CMFException
      Specified by:
      addToCmfModel in interface BaseCmfEntity<org.mitre.niem.cmf.HasProperty>
      Throws:
      org.mitre.niem.cmf.CMFException

    • toCmf

      public org.mitre.niem.cmf.HasProperty toCmf() throws org.mitre.niem.cmf.CMFException
      Specified by:
      toCmf in interface BaseCmfEntity<org.mitre.niem.cmf.HasProperty>
      Throws:
      org.mitre.niem.cmf.CMFException

    • builder

      public static Subproperty.SubpropertyBuilder builder()

    • getVersionId

      public Long getVersionId()
      Description copied from class: BaseVersionEntity
      Gets the version database id.
      Overrides:
      getVersionId in class BaseVersionEntity<Subproperty>

    • getMin

      public String getMin()
      Min cardinality 0 or 1-9 with zero or more additional digits.

    • getMax

      public String getMax()
      Max cardinality 'unbounded' or 1-9 with zero or more additional digits.

    • getSequence

      public int getSequence()

    • getDefinition

      @Nullable public String getDefinition()

    • setType

      public void setType(Type type)

    • setProperty

      public void setProperty(Property property)

    • setVersionId

      public void setVersionId(Long versionId)

    • setMin

      public void setMin(String min)
      Min cardinality 0 or 1-9 with zero or more additional digits.

    • setMax

      public void setMax(String max)
      Max cardinality 'unbounded' or 1-9 with zero or more additional digits.

    • setSequence

      public void setSequence(int sequence)

    • setDefinition

      public void setDefinition(@Nullable String definition)

    • setTypeQname

      public void setTypeQname(String typeQname)

    • setPropertyQname

      public void setPropertyQname(String propertyQname)

    • toString

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

    • equals

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

    • canEqual

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

    • hashCode

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