org.eclipse.higgins.idas.api
Interface IAttributeValue

All Superinterfaces:

IHasMetadata

All Known Subinterfaces:

IComplexAttrValue, ISimpleAttrValue

public interface IAttributeValue

extends IHasMetadata

Holds the value of an attribute.

This interface is not intended to be instantiated (only used as a super-interface). When the value is a Literal (isSimple() returns true), an instance of this interface may be cast to ISimpleAttrValue, and the table found at ITypedValue.getData() is used to determine the type returned from ITypedValue.getData(). When the value is a Resource (isSimple() returns false), an instance of this interface may be cast to IComplexAttrValue.

Field Summary

static String

BASE_OWL_URI Value: "http://www.eclipse.org/higgins/ontologies/2006/higgins#"

Method Summary

boolean	equals(IAttributeValue value) returns true if this IAttributeValue is equal to the passed IAttributeValue This should test the attribute ID, metadata, and the value for equality.
URI	getDataType() Deprecated. Instead, call getModel() and from that call IModel.getType(). Doing this is equivalent to calling this method.
IAttributeValueModel	getModel() Returns the model for this type of attribute value as it is defined in the context's schema.
boolean	isSimple()
void	remove() Removes this value from its IAttribute container Note: This operation is only applied to any backing data store after IContext.applyUpdates() is called.

Methods inherited from interface org.eclipse.higgins.idas.api.IHasMetadata

addMetadata, addMetadata, equals, getMetadata, getMetadataSet

Field Detail

BASE_OWL_URI

public static final String BASE_OWL_URI

Value: "http://www.eclipse.org/higgins/ontologies/2006/higgins#"

See Also:

Constant Field Values

Method Detail

isSimple

public boolean isSimple()
                 throws IdASException

Throws:

IdASException

getDataType

public URI getDataType()
                throws IdASException

Deprecated. Instead, call getModel() and from that call IModel.getType(). Doing this is equivalent to calling this method.

Returns this value's data type (like string, int, address) TODO (Doc): refer to an example like those found at http://wiki.eclipse.org/index.php/Person-with-address_Example_Context_Ontology

Returns:

The OWL type for this attribute's value (i.e. http://www.w3.org/2001/XMLSchema/string or http://www.eclipse.org/higgins/ontologies/2006/higgins#EntityRelation).

Throws:

IdASException

remove

public void remove()
            throws IdASException

Removes this value from its IAttribute container Note: This operation is only applied to any backing data store after IContext.applyUpdates() is called.

Throws:

{@link - IdASException}

IdASException

equals

public boolean equals(IAttributeValue value)
               throws IdASException

returns true if this IAttributeValue is equal to the passed IAttributeValue This should test the attribute ID, metadata, and the value for equality.

Throws:

IdASException

getModel

public IAttributeValueModel getModel()
                              throws IdASException

Returns the model for this type of attribute value as it is defined in the context's schema.

Returns:

the model for this attribute value

Throws:

IdASException