gate.relations

Class RelationSet

java.lang.Object

gate.relations.RelationSet

All Implemented Interfaces:

AnnotationSetListener, Serializable, Iterable<Relation>, Collection<Relation>, EventListener, Set<Relation>

public class RelationSet
extends Object
implements Serializable, AnnotationSetListener, Set<Relation>

Utility class for managing a set of GATE relations (usually each annotation set of a document will have one set of associated relations).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected AnnotationSet	annSet The AnnotationSet this set of relations relates to.
static int	ANY Annotation ID used when calling getRelations(int...) for positions with no restrictions.
protected Map<Integer,Relation>	indexById Index for relations by id.
protected Map<String,BitSet>	indexByType Index for relations by type.
protected List<Map<Integer,BitSet>>	indexesByMember Indexes for relations by member.

Constructor Summary

Constructors

Constructor and Description
RelationSet(AnnotationSet annSet) You should never create a RelationSet directly, instead get if via the AnnotationSet

Method Summary

Modifier and Type	Method and Description
boolean	add(Relation rel) Adds an externally-created Relation instance.
boolean	addAll(Collection<? extends Relation> relations)
Relation	addRelation(String type, int... members) Creates a new Relation and adds it to this set.
void	addRelationSetListener(RelationSetListener l)
void	annotationAdded(AnnotationSetEvent e) Called when a new Annotation has been added
void	annotationRemoved(AnnotationSetEvent e) Called when an Annotation has been removed
void	clear() Empties the relation set
boolean	contains(Object obj)
boolean	containsAll(Collection<?> relations)
boolean	deleteRelation(Relation relation) Deletes the specified relation.
protected void	fireRelationAdded(RelationSetEvent e)
protected void	fireRelationRemoved(RelationSetEvent e)
Collection<Relation>	get() An unmodifiable view of the contents of this RelationSet.
Relation	get(Integer id)
AnnotationSet	getAnnotationSet() The AnnotationSet which this instance belongs to.
int	getMaximumArity() Returns the maximum arity for any relation in this RelationSet.
Collection<Relation>	getReferencing(Integer id) Returns a collection of all Relation instances within this set which include the specified Annotation or Relation
Collection<Relation>	getRelations(int... members) Finds relations based on their members.
Collection<Relation>	getRelations(String type) Finds relations based on their type.
Collection<Relation>	getRelations(String type, int... members)
protected Collection<Relation>	intersection(BitSet... indexLists) Calculates the intersection of a set of lists containing relation IDs
boolean	isEmpty()
Iterator<Relation>	iterator()
boolean	remove(Object obj)
boolean	removeAll(Collection<?> relations)
void	removeRelationSetListener(RelationSetListener l)
boolean	retainAll(Collection<?> relations)
int	size() The number of relations in this set.
Object[]	toArray()
<T> T[]	toArray(T[] store)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set

equals, hashCode, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

ANY

public static final int ANY

Annotation ID used when calling getRelations(int...) for positions with no restrictions.

See Also:

Constant Field Values

indexByType

protected Map<String,BitSet> indexByType

Index for relations by type.

indexById

protected Map<Integer,Relation> indexById

Index for relations by id.

indexesByMember

protected List<Map<Integer,BitSet>> indexesByMember

Indexes for relations by member. Each element in the list refers to a given position in the members array: the element at position zero refers to the first member of all relations. The element at position pos is a map from annotation ID (representing a relation member) to a BitSet indicating which of the relation indexes correspond to relations that contain the given annotation (i.e. member) on the position pos.

annSet

protected AnnotationSet annSet

The AnnotationSet this set of relations relates to. The assumption (which is actively enforced) is that all members of this RelationSet will be either Annotation instances from this AnnotationSet or other Relation instances within this set.

Constructor Detail

RelationSet

public RelationSet(AnnotationSet annSet)

You should never create a RelationSet directly, instead get if via the AnnotationSet

Method Detail

getAnnotationSet

public AnnotationSet getAnnotationSet()

The AnnotationSet which this instance belongs to.

Returns:

the AnnotationSet which this instance belongs to.

get

public Collection<Relation> get()

An unmodifiable view of the contents of this RelationSet.

Returns:

an unmodifiable view of the contents of this RelationSet.

clear

public void clear()

Empties the relation set

Specified by:

clear in interface Collection<Relation>

Specified by:

clear in interface Set<Relation>

size

public int size()

The number of relations in this set.

Specified by:

size in interface Collection<Relation>

Specified by:

size in interface Set<Relation>

Returns:

the number of relations in this set.

addRelation

public Relation addRelation(String type,
                            int... members)
                     throws IllegalArgumentException

Creates a new Relation and adds it to this set. Uses the default relation implementation at SimpleRelation.

Parameters:

type - the type for the new relation.

members - the annotation IDs for the annotations that are members in this relation.

Returns:

the newly created Relation instance.

Throws:

IllegalArgumentException

add

public boolean add(Relation rel)

Adds an externally-created Relation instance.

Specified by:

add in interface Collection<Relation>

Specified by:

add in interface Set<Relation>

Parameters:

rel - the Relation to be added.

Returns:

true if the Relation was added to the set, false otherwise

getMaximumArity

public int getMaximumArity()

Returns the maximum arity for any relation in this RelationSet.

Returns:

an int value.

getRelations

public Collection<Relation> getRelations(String type)

Finds relations based on their type.

Parameters:

type - the type of relation being sought.

Returns:

the list of all relations in this RelationSet that have the required type.

get

public Relation get(Integer id)

getRelations

public Collection<Relation> getRelations(int... members)

Finds relations based on their members.

Parameters:

members - an array containing annotation IDs. If a constraint is not required for a given member position, then the ANY. value should be used.

Returns:

all the relations that have the given annotation IDs (members) on the specified positions.

getRelations

public Collection<Relation> getRelations(String type,
                                         int... members)

deleteRelation

public boolean deleteRelation(Relation relation)

Deletes the specified relation.

Parameters:

relation - the relation to be deleted.

Returns:

true if the given relation was deleted, or false if it was not found.

getReferencing

public Collection<Relation> getReferencing(Integer id)

Returns a collection of all Relation instances within this set which include the specified Annotation or Relation

Parameters:

id - the ID of the Annotation or Relation to look for

Returns:

a set of all Relation instances within this set which include the specified id

intersection

protected Collection<Relation> intersection(BitSet... indexLists)

Calculates the intersection of a set of lists containing relation IDs

Parameters:

indexLists - the list to be intersected.

Returns:

the list of relations contained in all the supplied index lists.

toString

public String toString()

Overrides:

toString in class Object

annotationAdded

public void annotationAdded(AnnotationSetEvent e)

Description copied from interface: AnnotationSetListener

Called when a new Annotation has been added

Specified by:

annotationAdded in interface AnnotationSetListener

annotationRemoved

public void annotationRemoved(AnnotationSetEvent e)

Description copied from interface: AnnotationSetListener

Called when an Annotation has been removed

Specified by:

annotationRemoved in interface AnnotationSetListener

removeRelationSetListener

public void removeRelationSetListener(RelationSetListener l)

addRelationSetListener

public void addRelationSetListener(RelationSetListener l)

fireRelationAdded

protected void fireRelationAdded(RelationSetEvent e)

fireRelationRemoved

protected void fireRelationRemoved(RelationSetEvent e)

addAll

public boolean addAll(Collection<? extends Relation> relations)

Specified by:

addAll in interface Collection<Relation>

Specified by:

addAll in interface Set<Relation>

contains

public boolean contains(Object obj)

Specified by:

contains in interface Collection<Relation>

Specified by:

contains in interface Set<Relation>

containsAll

public boolean containsAll(Collection<?> relations)

Specified by:

containsAll in interface Collection<Relation>

Specified by:

containsAll in interface Set<Relation>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<Relation>

Specified by:

isEmpty in interface Set<Relation>

iterator

public Iterator<Relation> iterator()

Specified by:

iterator in interface Iterable<Relation>

Specified by:

iterator in interface Collection<Relation>

Specified by:

iterator in interface Set<Relation>

remove

public boolean remove(Object obj)

Specified by:

remove in interface Collection<Relation>

Specified by:

remove in interface Set<Relation>

removeAll

public boolean removeAll(Collection<?> relations)

Specified by:

removeAll in interface Collection<Relation>

Specified by:

removeAll in interface Set<Relation>

retainAll

public boolean retainAll(Collection<?> relations)

Specified by:

retainAll in interface Collection<Relation>

Specified by:

retainAll in interface Set<Relation>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<Relation>

Specified by:

toArray in interface Set<Relation>

toArray

public <T> T[] toArray(T[] store)

Specified by:

toArray in interface Collection<Relation>

Specified by:

toArray in interface Set<Relation>