Package gov.niem.tools.api.db.property

Class Property

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<Property>
gov.niem.tools.api.db.base.BaseNamespaceEntity<Property>
gov.niem.tools.api.db.component.Component<Property>
gov.niem.tools.api.db.property.Property
All Implemented Interfaces:
BaseCmfEntity<org.mitre.niem.cmf.Property>, Serializable
@Entity @Indexed public class Property extends Component<Property> implements BaseCmfEntity<org.mitre.niem.cmf.Property>
A property represents a concept, idea, or thing.
See Also:

  • Constructor Details

    • Property

      protected Property(Property.PropertyBuilder<?,?> b)

    • Property

      public Property()

    • Property

      public Property(@Nullable Type type, @Nullable Property group, Property.Category category, String alias, String keywords, String exampleContent, String usageInfo, Set<Property> substitutions, Set<Subproperty> subproperties)
      Creates a new Property instance.
      Parameters:
      type - A type that describes the structure and value set of the property.
      group - A substitution group head, which may be replaced in message instances by this property.
      category - A kind of property.
      alias -
      keywords -
      exampleContent -
      usageInfo -
      substitutions -
      subproperties -

  • Method Details

    • getGroup

      public Property getGroup()
      Makes sure a potential Hibernate proxy is initialized.

    • getType

      public Type getType()
      Makes sure a potential Hibernate proxy is initialized.

    • isElement

      public boolean isElement()
      True if the property is a regular or abstract element; false if the property is an attribute.

    • isAttribute

      public boolean isAttribute()
      True if the property is an attribute; false if the property is a regular or abstract element.

    • isAbstract

      public boolean isAbstract()
      True if the property is an element and is abstract; false otherwise.

    • getTypeSummary

      public Map<String,String> getTypeSummary()

    • getGroupSummary

      public Map<String,String> getGroupSummary()

    • 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.
      Overrides:
      getTitle in class Component<Property>

    • 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.Property>
      Throws:
      org.mitre.niem.cmf.CMFException

    • toCmf

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

    • builder

      public static Property.PropertyBuilder<?,?> builder()

    • getCategory

      public Property.Category getCategory()
      A kind of property.
      Specified by:
      getCategory in class Component<Property>

    • getAlias

      public String getAlias()

    • getKeywords

      public String getKeywords()

    • getExampleContent

      public String getExampleContent()

    • getUsageInfo

      public String getUsageInfo()

    • getSubstitutions

      public Set<Property> getSubstitutions()

    • getSubproperties

      public Set<Subproperty> getSubproperties()

    • setType

      public void setType(@Nullable Type type)
      A type that describes the structure and value set of the property.

    • setGroup

      public void setGroup(@Nullable Property group)
      A substitution group head, which may be replaced in message instances by this property.

    • setCategory

      public void setCategory(Property.Category category)
      A kind of property.

    • setAlias

      public void setAlias(String alias)

    • setKeywords

      public void setKeywords(String keywords)

    • setExampleContent

      public void setExampleContent(String exampleContent)

    • setUsageInfo

      public void setUsageInfo(String usageInfo)

    • setSubstitutions

      public void setSubstitutions(Set<Property> substitutions)

    • setSubproperties

      public void setSubproperties(Set<Subproperty> subproperties)

    • toString

      public String toString()
      Overrides:
      toString in class Component<Property>

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Component<Property>

    • canEqual

      protected boolean canEqual(Object other)
      Overrides:
      canEqual in class Component<Property>

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Component<Property>