i3.dragos.gm.core.schema
Interface Attribute

All Superinterfaces:

ExistenceCheckable, MetaAttributable

All Known Implementing Classes:

AbstractAttribute, AttributeProxy

public interface Attribute
extends MetaAttributable, ExistenceCheckable

An Attribute uniquely identifies an attribute defined for a graph entity class in the schema.

Author:

Boris Boehlen <boehlen@cs.rwth-aachen.de>

See Also:

Core Graph Model, Implementation Issues

Method Summary

boolean	equals(java.lang.Object o) Checks for equality with another object.
DataSourceURL	getDataSourceURL() Returns the DataSourceURL of the schema this attribute belongs to.
GraphEntityClass	getGraphEntityClass() Returns the schema entity the attribute belongs to.
java.io.Serializable	getInternalIdentifier() Returns the internal internal identifier of the attribute.
java.lang.String	getName() Returns the attribute's name.
java.lang.Class	getType() Returns the attribute's value type.
Attribute	getWrappedAttribute() Returns the wrapped attribute, null if none.
int	hashCode() To comply with the general contract for Object.hashCode(), it is recommended to return the hash code of the internal identifier.

Methods inherited from interface i3.dragos.gm.core.schema.MetaAttributable

getAllMetaAttributes, getMetaAttribute, isMetaAttributeKeyReserved, isMetaAttributeSet, setMetaAttribute, unsetMetaAttribute

Methods inherited from interface i3.dragos.gm.core.schema.ExistenceCheckable

checkExistence, checkExistenceOptional

Method Detail

getGraphEntityClass

GraphEntityClass getGraphEntityClass()
                                     throws DragosException

Returns the schema entity the attribute belongs to.

Returns:

the schema entity the attribute belongs to.

Throws:

DragosException - if something went wrong.

getInternalIdentifier

java.io.Serializable getInternalIdentifier()

Returns the internal internal identifier of the attribute.

Returns:

the internal internal identifier of the attribute.

getName

java.lang.String getName()

Returns the attribute's name.

Returns:

the attribute's name.

getType

java.lang.Class getType()

Returns the attribute's value type.

Returns:

the attribute's value type.

getDataSourceURL

DataSourceURL getDataSourceURL()

Returns the DataSourceURL of the schema this attribute belongs to. The returned value is guaranteed to not be null.

Returns:

The DataSourceURL of the Schema this attribute belongs to.

equals

boolean equals(java.lang.Object o)

Checks for equality with another object.

This object is considered equal if all of the following conditions are met:

• o != null
• o instanceof AbstractAttribute
• getDataSourceURL().equals(((GraphEntity) o).getDataSourceURL())
• getInternalIdentifier().equals(((GraphEntity) o).getInternalIdentifier())

Subclasses and implementations might want to extend it by adding assertions comparing additional or internal data. However, equality must only be determined by above rules, preferably by using super.equals(o), and any differences in the additional data for two equal attributes is to be considered an error.

Overrides:

equals in class java.lang.Object

Parameters:

o - The Object to compare to.

Returns:

true if o is equal according to above rules, false otherwise.

hashCode

int hashCode()

To comply with the general contract for Object.hashCode(), it is recommended to return the hash code of the internal identifier.

Overrides:

hashCode in class java.lang.Object

Returns:

The hash code.

getWrappedAttribute

Attribute getWrappedAttribute()

Returns the wrapped attribute, null if none.

Returns:

the wrapped attribute, null if none.