org.hl7.meta
Interface Feature

All Superinterfaces:

java.lang.Cloneable, Metadata

All Known Subinterfaces:

Association, Attribute, ChoiceAssociation, CloneClassAssociation, CmetAssociation

All Known Implementing Classes:

AssociationAdapter, AttributeAdapter, ChoiceAssociationAdapter, ChoiceBranchAssociationAdapter, CmetAssociationAdapter, CmetChoiceAssociationAdapter, CmetChoiceBranchAssociationAdapter, FeatureAdapter

public interface Feature
extends Metadata

A read only interface to the class FeatureImpl, which is a common parent class for both AttributeImpl and AssociationImpl. Feature is the commonality between an attribute and an association inside a clone class.

Author:

Skirmantas Kligys (skirmis@hotmail.com)

Method Summary

Cardinality	getCardinality() Returns the feature's cardinality.
Conformance	getConformance() Returns the conformance field attached to this feature.
java.lang.String	getConstraint() Returns the textual constraint note attached to the feature.
java.lang.String	getName() Returns the feature's name, which may be the attribute name, or the short name in case of an association.
CloneClass	getParent() Returns the clone class where the feature belongs.
java.lang.String	getRimClass() Returns the name of the RIM class where the feature was originally defined.
java.lang.String	getRimPropertyName() Returns the property name inside the RIM class.
int	getSortKey() Returns the feature's sort key.
boolean	isMandatory() Returns a flag showing if the feature is mandatory in the clone class.

Method Detail

getName

java.lang.String getName()

Returns the feature's name, which may be the attribute name, or the short name in case of an association.

Returns:

the feature's name

getSortKey

int getSortKey()

Returns the feature's sort key.

Returns:

the feature's sort key

getCardinality

Cardinality getCardinality()

Returns the feature's cardinality.

Returns:

the feature's cardinality

getRimClass

java.lang.String getRimClass()

Returns the name of the RIM class where the feature was originally defined.

Returns:

the RIM class name

getRimPropertyName

java.lang.String getRimPropertyName()

Returns the property name inside the RIM class. This may be the attribute name or the association name.

Returns:

the RIM Property name

getParent

CloneClass getParent()

Returns the clone class where the feature belongs.

Returns:

the clone class

isMandatory

boolean isMandatory()

Returns a flag showing if the feature is mandatory in the clone class.

Returns:

the flag

getConformance

Conformance getConformance()

Returns the conformance field attached to this feature.

Returns:

the conformance field

getConstraint

java.lang.String getConstraint()

Returns the textual constraint note attached to the feature.

Returns:

the constraint note