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.BaseVersionedEntity<Property>

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, Comparable<Component<Property>>

@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:

• NIEM Property info
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Property.Category	A kind of property indicating whether is is a concrete element, abstract element, or attribute.
static enum	Property.ContentStyle	An alternate way to categorize a property based on its type.

Field Summary

Fields inherited from class gov.niem.tools.api.db.component.Component

definition, name, namespaceRank, prefix, qname

Constructor Summary

Constructors

Constructor	Description
Property()

Method Summary

Modifier and Type	Method	Description
org.mitre.niem.cmf.Component	addToCmfModel(org.mitre.niem.cmf.Model cmfModel, boolean addDependencies, AddModelReason addModelReason, Test test)	Adds this property as a data property to the given CMF model if not already present.
String	getClassName()	A kind of NIEM entity, such as a Namespace or a Property.
Property.ContentStyle	getContentStyle()	An alternate way to categorize a property based on its type.
Property	getGroup()	Makes sure a potential Hibernate proxy is initialized.
Map<String,String>	getGroupSummary()
String	getIdLabel()	A human-readable and url-friendly unique identifier for an entity.
String	getIdLocalLabel()	An identifier, unique within its immediate scope.
String	getRoute()	An endpoint to get information about an entity.
String	getTitle()	A descriptive label or title used to identify an entity.
Type	getType()	Makes sure a potential Hibernate proxy is initialized.
Map<String,String>	getTypeSummary()
boolean	isAbstract()	True if the property is an element and is abstract; false otherwise.
boolean	isAttribute()	True if the property is an attribute; false if the property is a regular or abstract element.
boolean	isCmfDataProperty()	True if this property can be considered a CMF data property; false if it is a CMF object property.
boolean	isElement()	True if the property is a regular or abstract element; false if the property is an attribute.
org.mitre.niem.cmf.Property	toCmf()
org.mitre.niem.cmf.DataProperty	toCmfDataProperty()	Converts a property to a CMF data property.
org.mitre.niem.cmf.ObjectProperty	toCmfObject()	Converts a property to a CMF object property.

Methods inherited from class gov.niem.tools.api.db.component.Component

compareTo, getCategory, getName, getNamespace, getParentEntity, getPrefix, getTerms, toSummary

Methods inherited from class gov.niem.tools.api.db.base.BaseNamespaceEntity

getNamespaceId, getNamespaceSummary, getVersion

Methods inherited from class gov.niem.tools.api.db.base.BaseVersionEntity

getCurrent, getModel, getNiemVersion, getNiemVersionNumber, getOriginal, getVersionId, getVersionNumber, getVersionSummary, isCurrent, isOriginal

Methods inherited from class gov.niem.tools.api.db.base.BaseVersionedEntity

getNext, getPrev

Methods inherited from class gov.niem.tools.api.db.base.BaseModelEntity

getModelKey, getModelSummary, getSteward

Methods inherited from class gov.niem.tools.api.db.base.BaseStewardEntity

getStewardKey, getStewardSummary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Property

public Property()

Method Details

getContentStyle

public Property.ContentStyle getContentStyle()

An alternate way to categorize a property based on its type. Identifies whether it carries properties (an object)

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

getIdLabel

public String getIdLabel()

Description copied from class: BaseEntity

A human-readable and url-friendly unique identifier for an entity.

Specified by:

getIdLabel in class BaseEntity

getIdLocalLabel

public String getIdLocalLabel()

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:

getIdLocalLabel 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>

isCmfDataProperty

public boolean isCmfDataProperty()

True if this property can be considered a CMF data property; false if it is a CMF object property.

addToCmfModel

public org.mitre.niem.cmf.Component addToCmfModel(org.mitre.niem.cmf.Model cmfModel,
 boolean addDependencies,
 AddModelReason addModelReason,
 Test test)
                                           throws org.mitre.niem.cmf.CMFException,
EntityNotUniqueException

Adds this property as a data property to the given CMF model if not already present.

Specified by:

addToCmfModel in interface BaseCmfEntity<org.mitre.niem.cmf.Property>

Parameters:

cmfModel - The CMF model

addDependencies - True to also add property dependencies if not already in the CMF model (namespace, type, group); false to just add this property.

addModelReason - Indicates the reason why a component is being added to the model, either directly due to a task like migration or transformation, or indirectly as a required dependency.

test - If present, log info to given test object.

Throws:

org.mitre.niem.cmf.CMFException

EntityNotUniqueException

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

toCmfObject

public org.mitre.niem.cmf.ObjectProperty toCmfObject()
                                              throws org.mitre.niem.cmf.CMFException

Converts a property to a CMF object property.

Throws:

org.mitre.niem.cmf.CMFException

toCmfDataProperty

public org.mitre.niem.cmf.DataProperty toCmfDataProperty()
                                                  throws org.mitre.niem.cmf.CMFException

Converts a property to a CMF data property.

Throws:

org.mitre.niem.cmf.CMFException