org.meta2project.model
Interface AnnotatedEntity

All Known Subinterfaces:
NamedEntity, OntClass, OntObject, Ontology, OProperty, Property, TProperty, Type
All Known Implementing Classes:
BoxNamedEntity, BoxOntClass, BoxOntObject, BoxOntology, BoxOProperty, BoxProperty, BoxTProperty, BoxType, DBEntity, DBOntClass, DBOntObject, DBOntObjectBase, DBOntology, DBOProperty, DBTProperty, DBType, DebugAnnotatedEntity, DebugNamedEntity, DebugOntClass, DebugOntObject, DebugOntology, DebugOProperty, DebugTProperty, DebugType

public interface AnnotatedEntity

An entity that can be annotated. This entity can have annotations. Annotation values are identified by names. A name must be a global unique URI as a full name (with the # symbol inside). The type of annotation values is String.

Author:
Anton Malykh
See Also:
Ontology, OntClass, OntObject, TProperty, OProperty

Field Summary
static java.lang.String CASCADE
          Cascade annotation
static java.lang.String CASCADE_DELETE_VALUE
           
static java.lang.String COMMENT
          Comment annotation
static java.lang.String MAX_CARD
          Deprecated.  
static java.lang.String MIN_CARD
          Deprecated.  
static java.lang.String MODEL_URI
           
static java.lang.String TITLE
          Title (short) annotation
 
Method Summary
 java.lang.String getAnnotation(java.lang.String name)
          Get annotation value by this name.
 java.util.List<java.lang.String> getAnnotationNames()
          Get annotation names for this entity.
 void putAnnotation(java.lang.String name, java.lang.String value)
          Put annotation value.
 

Field Detail

MODEL_URI

static final java.lang.String MODEL_URI
See Also:
Constant Field Values

TITLE

static final java.lang.String TITLE
Title (short) annotation

See Also:
Constant Field Values

COMMENT

static final java.lang.String COMMENT
Comment annotation

See Also:
Constant Field Values

CASCADE

static final java.lang.String CASCADE
Cascade annotation

See Also:
Constant Field Values

CASCADE_DELETE_VALUE

static final java.lang.String CASCADE_DELETE_VALUE
See Also:
Constant Field Values

MIN_CARD

static final java.lang.String MIN_CARD
Deprecated. 
Min. cardinality

See Also:
Box.MIN_CARD, Constant Field Values

MAX_CARD

static final java.lang.String MAX_CARD
Deprecated. 
Max. cardinality

See Also:
Box.MAX_CARD, Constant Field Values
Method Detail

getAnnotationNames

java.util.List<java.lang.String> getAnnotationNames()
Get annotation names for this entity.

Returns:
name list (in ascending order)

getAnnotation

java.lang.String getAnnotation(java.lang.String name)
Get annotation value by this name.

Parameters:
name - annotation name
Returns:
annotation value; null if there is no value for this name

putAnnotation

void putAnnotation(java.lang.String name,
                   java.lang.String value)
Put annotation value.

Parameters:
name - annotation name
value - annotation value; value will be removed if null