i3.dragos.gm.core
Interface RelationEnd

All Superinterfaces:

ExistenceCheckable, GraphEntity, MetaAttributable

All Known Implementing Classes:

RelationEndProxy

public interface RelationEnd
extends GraphEntity

The RelationEnd interface represents the end of a n-ary relation which is connected to a particular graph element.

Author:

Peter Kehren, Boris Boehlen <boehlen@cs.rwth-aachen.de>, Thorsten Hermes <thermes@i3.informatik.rwth-aachen.de>

See Also:

Core Graph Model, Implementation Issues

Method Summary

Relation	getRelation() Returns the relation the relation end belongs to.
RelationEndClass	getRelationEndClass() Returns the relation end's type.
GraphEntity	relatesTo() Returns the graph element the relation end is connected to.
void	relateTo(GraphEntity g) Sets the graph element the relation end is connected to.

Methods inherited from interface i3.dragos.gm.core.GraphEntity

equals, getAdjacentGraphEntities, getAdjacentRelations, getAdjacentRelations, getAllValidAttributeValues, getAttributeValue, getDataSourceURL, getEdges, getEdges, getGraphEntityClass, getInternalIdentifier, getParent, getRelationEnds, getRelationEnds, getRelationEnds, getWrappedGraphEntity, hashCode, isAttributeValid, isIncident, isIncident, putAttributeValue, setAttributeInvalid

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

getRelationEndClass

RelationEndClass getRelationEndClass()
                                     throws DragosException

Returns the relation end's type.

Returns:

the relation end's type.

Throws:

DragosException - if something went wrong.

relatesTo

GraphEntity relatesTo()
                      throws DragosException

Returns the graph element the relation end is connected to.

Returns:

The referenced graph element (may be null)

Throws:

DragosException - if something went wrong.

relateTo

void relateTo(GraphEntity g)
              throws EntityNotFoundException,
                     DragosException

Sets the graph element the relation end is connected to.

Parameters:

g - The graphelement to connect to (may be null).

Throws:

EntityNotFoundException - if the target was not null and could not be found.

DragosException - if something went wrong.

getRelation

Relation getRelation()
                     throws DragosException

Returns the relation the relation end belongs to.

Returns:

The relation

Throws:

DragosException - if something went wrong.