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

Class BaseEntity

java.lang.Object

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BaseStewardEntity, Steward

@MappedSuperclass
public abstract class BaseEntity
extends Object
implements Serializable

A parent class for all kinds of entities used to represent the structure of a NIEM model.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
BaseEntity()

Method Summary

Modifier and Type	Method	Description
String	getClassName()	A kind of NIEM entity, such as a Namespace or a Property.
abstract String	getIdLabel()	A human-readable and url-friendly unique identifier for an entity.
abstract String	getIdLocalLabel()	An identifier, unique within its immediate scope.
abstract BaseEntity	getParentEntity()	An immediate entity or scope to which this entity belongs.
abstract String	getRoute()	An endpoint to get information about an entity.
abstract String	getTitle()	A descriptive label or title used to identify an entity.

Methods inherited from class java.lang.Object

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

Constructor Details

BaseEntity

public BaseEntity()

Method Details

getIdLabel

public abstract String getIdLabel()

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

getIdLocalLabel

public abstract String getIdLocalLabel()

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.

getClassName

public String getClassName()

A kind of NIEM entity, such as a Namespace or a Property.

getRoute

public abstract String getRoute()

An endpoint to get information about an entity.

getTitle

public abstract String getTitle()

A descriptive label or title used to identify an entity.

getParentEntity

public abstract BaseEntity getParentEntity()

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.