Package gov.niem.tools.api.db.base

Class BaseVersionEntity<T extends BaseVersionEntity<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.BaseVersionedEntity<T>

gov.niem.tools.api.db.base.BaseVersionEntity<T>

Type Parameters:

T - A class for a kind of entity that that belongs to a version, such as Namespace, Property, Type, or Facet.

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BaseNamespaceEntity, Namespace

@MappedSuperclass
public abstract class BaseVersionEntity<T extends BaseVersionEntity<T>>
extends BaseVersionedEntity<T>

Adds reusable methods for entities that belong to a version: Namespace, Property, etc.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
BaseVersionEntity()

Method Summary

Modifier and Type	Method	Description
T	getCurrent()	Get the corresponding entity from the current version via migration rules.
Model	getModel()	Gets the Model that defines this object.
Version	getNiemVersion()	Gets the NIEM Version object that is compatible with this object.
String	getNiemVersionNumber()	Gets the NIEM Version number (string) that is compatible with this object.
T	getOriginal()	For a component in a subset, gets the component from the original source.
abstract Version	getVersion()
Long	getVersionId()	Gets the version database id.
String	getVersionNumber()	A number which identifies a version within a model.
Map<String,String>	getVersionSummary()
boolean	isCurrent()	True if this entity is from the current version; false otherwise.
boolean	isOriginal()	True if an entity is defined by its version and can be modified freely; false if an entity is being referenced and reused from another model and version and is restricted in the changes that can be made (subset options).

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 gov.niem.tools.api.db.base.BaseEntity

getClassName, getIdLabel, getIdLocalLabel, getParentEntity, getRoute, getTitle

Methods inherited from class java.lang.Object

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

Constructor Details

BaseVersionEntity

public BaseVersionEntity()

Method Details

getVersion

public abstract Version getVersion()

isCurrent

public boolean isCurrent()
                  throws EntityNotFoundException

True if this entity is from the current version; false otherwise.

Throws:

EntityNotFoundException

getCurrent

public T getCurrent()

Get the corresponding entity from the current version via migration rules.

getOriginal

public T getOriginal()

For a component in a subset, gets the component from the original source.

isOriginal

public boolean isOriginal()

True if an entity is defined by its version and can be modified freely; false if an entity is being referenced and reused from another model and version and is restricted in the changes that can be made (subset options).

getVersionId

public Long getVersionId()

Gets the version database id.

getVersionSummary

public Map<String,String> getVersionSummary()

getVersionNumber

public String getVersionNumber()

A number which identifies a version within a model.

getNiemVersion

public Version getNiemVersion()

Gets the NIEM Version object that is compatible with this object.

getNiemVersionNumber

public String getNiemVersionNumber()

Gets the NIEM Version number (string) that is compatible with this object.

getModel

public Model getModel()

Gets the Model that defines this object.

Specified by:

getModel in class BaseModelEntity