Package gov.niem.tools.api.db.model

Class Model

java.lang.Object

gov.niem.tools.api.db.base.BaseEntity

gov.niem.tools.api.db.base.BaseStewardEntity

gov.niem.tools.api.db.model.Model

All Implemented Interfaces:

Serializable, Comparable<Model>

@Entity
@Indexed
public class Model
extends BaseStewardEntity
implements Comparable<Model>

A reference or message data model.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Model.Category	A kind of model, such as reference, message, or other.
static enum	Model.Objective	A kind of message objective, such as implementation, example, or test.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	niemModelKey

Constructor Summary

Constructors

Constructor	Description
Model(String shortName)	Creates a model with the given fields.
Model(String shortName, String longName, Model.Category category)	Creates a model with the given fields.
Model(String shortName, String longName, Steward steward, Model.Category category)	Creates a model with the given fields.

Method Summary

Modifier and Type	Method	Description
int	compareTo(Model other)	Custom sorting function for models.
String	getClassName()	A kind of NIEM entity, such as a Namespace or a Property.
String	getIdLabel()	A human-readable and url-friendly unique identifier for an entity.
String	getIdLocalLabel()	An identifier, unique within its immediate scope.
String	getNiemRoute()	Gets the API route to the NIEM model.
Steward	getParentEntity()	An immediate entity or scope to which this entity belongs.
String	getRoute()	An endpoint to get information about an entity.
Steward	getSteward()	Gets the Steward responsible for this model.
String	getTitle()	A descriptive label or title used to identify an entity.
List<Version>	getVersions()	Gets a sorted list of versions that belong to this model.
Map<String,String>	toSummary()	Gets keys fields about the model.

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

Field Details

niemModelKey

public static final String niemModelKey

See Also:

• Constant Field Values

Constructor Details

Model

public Model(String shortName)

Creates a model with the given fields.

Model

public Model(String shortName,
 String longName,
 Model.Category category)

Creates a model with the given fields.

Model

public Model(String shortName,
 String longName,
 Steward steward,
 Model.Category category)

Creates a model with the given fields.

Method Details

getSteward

public Steward getSteward()

Gets the Steward responsible for this model. Makes sure a potential Hibernate proxy is initialized.

Specified by:

getSteward in class BaseStewardEntity

getVersions

public List<Version> getVersions()

Gets a sorted list of versions that belong to this model. Makes sure potential Hibernate proxies are initialized.

getParentEntity

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

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.

Specified by:

getTitle in class BaseEntity

getNiemRoute

public String getNiemRoute()

Gets the API route to the NIEM model.

toSummary

public Map<String,String> toSummary()

Gets keys fields about the model.

compareTo

public int compareTo(Model other)

Custom sorting function for models. Return the NIEM reference model first, then other NIEM models, then remaining models sorted by model key.

Specified by:

compareTo in interface Comparable<Model>