org.apache.polygene.api.association

Class ManyAssociationWrapper

java.lang.Object

org.apache.polygene.api.association.ManyAssociationWrapper

All Implemented Interfaces:

Iterable<Object>, AbstractAssociation, ManyAssociation<Object>

public class ManyAssociationWrapper
extends Object
implements ManyAssociation<Object>

If you want to catch calls to ManyAssociations, then create a GenericConcern that wraps the Polygene-supplied ManyAssociation instance with ManyAssociationWrappers. Override methods to perform your custom code.

Field Summary

Fields

Modifier and Type	Field and Description
protected ManyAssociation<Object>	next

Constructor Summary

Constructors

Constructor and Description
ManyAssociationWrapper(ManyAssociation<Object> next)

Method Summary

Modifier and Type	Method and Description
boolean	add(int i, Object entity) Adds an entity reference representing the given entity to the index slot of this collection.
boolean	add(Object entity) Adds an entity reference representing the given entity to the end of this collection.
boolean	clear() Clear all entities from this ManyAssociation.
boolean	contains(Object entity) Check is the entity is part of this ManyAssociation.
int	count() Returns the number of references in this association.
boolean	equals(Object obj)
Object	get(int i) Fetch the entity refrence at the given index and fetch the entity from the entity store.
int	hashCode()
Iterator<Object>	iterator()
ManyAssociation<Object>	next()
Stream<EntityReference>	references() Returns a stream of the references to the associated entities.
boolean	remove(Object entity) Removes the given entity from this ManyAssociation.
List<Object>	toList() Fetches all entities represented by entity references in this collection and returns a List of such entities.
Set<Object>	toSet() Fetches all entities represented by entity references in this collection and returns a Set of such entities.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

next

protected ManyAssociation<Object> next

Constructor Detail

ManyAssociationWrapper

public ManyAssociationWrapper(ManyAssociation<Object> next)

Method Detail

next

public ManyAssociation<Object> next()

count

public int count()

Description copied from interface: ManyAssociation

Returns the number of references in this association.

Specified by:

count in interface ManyAssociation<Object>

Returns:

the number of references in this association.

contains

public boolean contains(Object entity)

Description copied from interface: ManyAssociation

Check is the entity is part of this ManyAssociation.

Specified by:

contains in interface ManyAssociation<Object>

Parameters:

entity - The entity to be checking for.

Returns:

true if there is an entity in this ManyAssociation with the same Identity as the given entity , otherwise false.

add

public boolean add(int i,
                   Object entity)

Description copied from interface: ManyAssociation

Adds an entity reference representing the given entity to the index slot of this collection.

index=0 represents the beginning of the collection and if the index is equal or larger than the length of the collection, the entity reference will be added to the end.

Specified by:

add in interface ManyAssociation<Object>

Parameters:

i - the position for the entity to be inserted at, starting at 0. If index is larger than number of references present, then it will be added to the end. If index is smaller than 0, then it will be added at the beginning, position 0.

entity - The entity whose entity reference is to be added to this collection.

Returns:

true if the entity reference has been added, false otherwise.

add

public boolean add(Object entity)

Description copied from interface: ManyAssociation

Adds an entity reference representing the given entity to the end of this collection.

Specified by:

add in interface ManyAssociation<Object>

Parameters:

entity - The entity whose entity reference is to be added to this collection.

Returns:

true if the entity reference has been added, false otherwise.

remove

public boolean remove(Object entity)

Description copied from interface: ManyAssociation

Removes the given entity from this ManyAssociation.

The entity reference representing the given entity is removed from this collection.

Specified by:

remove in interface ManyAssociation<Object>

Parameters:

entity - The entity reference to be removed.

Returns:

true if an entity reference was removed, otherwise false

clear

public boolean clear()

Description copied from interface: ManyAssociation

Clear all entities from this ManyAssociation.

All entity references present is removed from this collection.

Specified by:

clear in interface ManyAssociation<Object>

Returns:

true if any entity reference was removed, otherwise false

get

public Object get(int i)

Description copied from interface: ManyAssociation

Fetch the entity refrence at the given index and fetch the entity from the entity store.

Specified by:

get in interface ManyAssociation<Object>

Parameters:

i - The index location in the collection of the entity reference to be fetched.

Returns:

The retrieved entity that the entity reference of this collection represents.

toList

public List<Object> toList()

Description copied from interface: ManyAssociation

Fetches all entities represented by entity references in this collection and returns a List of such entities.

Multiple references to the same entity will be present multiple times in the List, unlike ManyAssociation.toSet(). The order in which the entities were added to this collection is preserved.

Specified by:

toList in interface ManyAssociation<Object>

Returns:

a List of entities represented by the entity references in this collection.

toSet

public Set<Object> toSet()

Description copied from interface: ManyAssociation

Fetches all entities represented by entity references in this collection and returns a Set of such entities.

Multiple references to the same entity will NOT be present, unlike ManyAssociation.toList(). Sets are defined to only contain any particular object once. Order is not preserved.

Specified by:

toSet in interface ManyAssociation<Object>

Returns:

a Set of entities represented by the entity references in this collection.

references

public Stream<EntityReference> references()

Description copied from interface: ManyAssociation

Returns a stream of the references to the associated entities.

Specified by:

references in interface ManyAssociation<Object>

Returns:

the references to the associated entities.

iterator

public Iterator<Object> iterator()

Specified by:

iterator in interface Iterable<Object>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object