xdi2.core.features.nodetypes

Class XdiAbstractCollection<EQC extends XdiCollection<EQC,EQI,C,U,O,I>,EQI extends XdiSubGraph<EQI>,C extends XdiCollection<EQC,EQI,C,U,O,I>,U extends XdiInstanceUnordered<EQC,EQI,C,U,O,I>,O extends XdiInstanceOrdered<EQC,EQI,C,U,O,I>,I extends XdiInstance<EQC,EQI,C,U,O,I>>

java.lang.Object

xdi2.core.features.nodetypes.XdiAbstractContext<EQ>

xdi2.core.features.nodetypes.XdiAbstractSubGraph<EQC>

xdi2.core.features.nodetypes.XdiAbstractCollection<EQC,EQI,C,U,O,I>

All Implemented Interfaces:

Serializable, Comparable<XdiContext<?>>, XdiCollection<EQC,EQI,C,U,O,I>, XdiContext<EQC>, XdiSubGraph<EQC>

Direct Known Subclasses:

XdiAttributeCollection, XdiEntityCollection

public abstract class XdiAbstractCollection<EQC extends XdiCollection<EQC,EQI,C,U,O,I>,EQI extends XdiSubGraph<EQI>,C extends XdiCollection<EQC,EQI,C,U,O,I>,U extends XdiInstanceUnordered<EQC,EQI,C,U,O,I>,O extends XdiInstanceOrdered<EQC,EQI,C,U,O,I>,I extends XdiInstance<EQC,EQI,C,U,O,I>>
extends XdiAbstractSubGraph<EQC>
implements XdiCollection<EQC,EQI,C,U,O,I>

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XdiAbstractCollection.MappingContextNodeXdiCollectionIterator
class	XdiAbstractCollection.XdiInstancesOrderedIterator
class	XdiAbstractCollection.XdiInstancesUnorderedIterator

Nested classes/interfaces inherited from interface xdi2.core.features.nodetypes.XdiContext

XdiContext.MappingXdiContextContextNodeIterator

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XdiAbstractCollection(ContextNode contextNode, Class<C> c, Class<U> u, Class<O> o, Class<I> i)

Method Summary

Modifier and Type	Method and Description
static XDIArc	createXDIArc(Character cs, boolean attribute, boolean immutable, boolean relative, String literal, XDIXRef xref)
static XdiCollection<?,?,?,?,?,?>	fromContextNode(ContextNode contextNode) Factory method that creates an XDI collection bound to a given context node.
static XdiCollection<?,?,?,?,?,?>	fromXDIAddress(XDIAddress XDIaddress)
Class<C>	getC()
Class<I>	getI()
Class<O>	getO()
Class<U>	getU()
O	getXdiInstanceOrdered(boolean attribute, boolean immutable, boolean relative, long index) Gets an XDI instance under this XDI collection.
ReadOnlyIterator<I>	getXdiInstances() Returns all XDI instances and instances in this XDI collection.
ReadOnlyIterator<EQI>	getXdiInstancesDeref() Returns all XDI instances and instances in this XDI collection.
ReadOnlyIterator<O>	getXdiInstancesOrdered() Returns all XDI instances in this XDI collection.
long	getXdiInstancesOrderedCount() Returns the number of XDI instances in this XDI collection.
ReadOnlyIterator<U>	getXdiInstancesUnordered() Returns all XDI instances in this XDI collection.
long	getXdiInstancesUnorderedCount() Returns the number of XDI instances in this XDI collection.
U	getXdiInstanceUnordered(boolean attribute, boolean immutable, boolean relative, String literal) gets an XDI instance under this XDI collection.
static boolean	isValid(ContextNode contextNode) Checks if a context node is a valid XDI collection.
static boolean	isValidXDIArc(XDIArc XDIarc)
I	setXdiInstance(XDIArc XDIarc) Sets an XDI instance under this XDI collection.
O	setXdiInstanceOrdered(boolean attribute) Sets an XDI instance under this XDI collection.
O	setXdiInstanceOrdered(boolean attribute, boolean immutable, boolean relative) Sets an XDI instance under this XDI collection.
O	setXdiInstanceOrdered(boolean attribute, boolean immutable, boolean relative, long index) Sets an XDI instance under this XDI collection.
O	setXdiInstanceOrdered(boolean attribute, long index) Sets an XDI instance under this XDI collection.
U	setXdiInstanceUnordered(boolean attribute) Sets an XDI instance under this XDI collection.
U	setXdiInstanceUnordered(boolean attribute, boolean immutable, boolean relative) Sets an XDI instance under this XDI collection.
U	setXdiInstanceUnordered(boolean attribute, boolean immutable, boolean relative, String literal) Sets an XDI instance under this XDI collection.
U	setXdiInstanceUnordered(boolean attribute, String literal) Sets an XDI instance under this XDI collection.

Methods inherited from class xdi2.core.features.nodetypes.XdiAbstractContext

compareTo, dereference, dereference, equals, findLocalRoot, findRoot, fromContextNode, fromXDIAddress, getBaseXDIArc, getBaseXDIArc, getContextNode, getGraph, getIdentityXdiContext, getIdentityXdiContexts, getReferenceXdiContext, getReplacementXdiContext, getXDIAddress, getXDIArc, getXdiAttribute, getXdiAttribute, getXdiAttributeCollection, getXdiAttributeCollection, getXdiAttributeSingleton, getXdiAttributeSingleton, getXdiContext, getXdiEntity, getXdiEntity, getXdiEntityCollection, getXdiEntityCollection, getXdiEntitySingleton, getXdiEntitySingleton, getXdiInnerRoot, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface xdi2.core.features.nodetypes.XdiCollection

getXdiInstanceOrdered, getXdiInstanceUnordered, setXdiInstanceOrdered, setXdiInstanceOrdered, setXdiInstanceOrdered, setXdiInstanceOrdered, setXdiInstanceUnordered, setXdiInstanceUnordered, setXdiInstanceUnordered, setXdiInstanceUnordered

Methods inherited from interface xdi2.core.features.nodetypes.XdiContext

dereference, dereference, findLocalRoot, findRoot, getBaseXDIArc, getContextNode, getGraph, getIdentityXdiContext, getIdentityXdiContexts, getReferenceXdiContext, getReplacementXdiContext, getXDIAddress, getXDIArc, getXdiAttribute, getXdiAttribute, getXdiAttributeCollection, getXdiAttributeCollection, getXdiAttributeSingleton, getXdiAttributeSingleton, getXdiContext, getXdiEntity, getXdiEntity, getXdiEntityCollection, getXdiEntityCollection, getXdiEntitySingleton, getXdiEntitySingleton, getXdiInnerRoot

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

XdiAbstractCollection

protected XdiAbstractCollection(ContextNode contextNode,
                                Class<C> c,
                                Class<U> u,
                                Class<O> o,
                                Class<I> i)

Method Detail

isValid

public static boolean isValid(ContextNode contextNode)

Checks if a context node is a valid XDI collection.

Parameters:

contextNode - The context node to check.

Returns:

True if the context node is a valid XDI collection.

fromContextNode

public static XdiCollection<?,?,?,?,?,?> fromContextNode(ContextNode contextNode)

Factory method that creates an XDI collection bound to a given context node.

Parameters:

contextNode - The context node that is an XDI collection.

Returns:

The XDI collection.

fromXDIAddress

public static XdiCollection<?,?,?,?,?,?> fromXDIAddress(XDIAddress XDIaddress)

setXdiInstance

public I setXdiInstance(XDIArc XDIarc)

Sets an XDI instance under this XDI collection.

Specified by:

setXdiInstance in interface XdiCollection<EQC extends XdiCollection<EQC,EQI,C,U,O,I>,EQI extends XdiSubGraph<EQI>,C extends XdiCollection<EQC,EQI,C,U,O,I>,U extends XdiInstanceUnordered<EQC,EQI,C,U,O,I>,O extends XdiInstanceOrdered<EQC,EQI,C,U,O,I>,I extends XdiInstance<EQC,EQI,C,U,O,I>>

Returns:

The XDI instance.

setXdiInstanceUnordered

public U setXdiInstanceUnordered(boolean attribute)

Sets an XDI instance under this XDI collection.

Returns:

The XDI instance.

setXdiInstanceUnordered

public U setXdiInstanceUnordered(boolean attribute,
                                 String literal)

Sets an XDI instance under this XDI collection.

Returns:

The XDI instance.

setXdiInstanceUnordered

public U setXdiInstanceUnordered(boolean attribute,
                                 boolean immutable,
                                 boolean relative)

Sets an XDI instance under this XDI collection.

Returns:

The XDI instance.

setXdiInstanceUnordered

public U setXdiInstanceUnordered(boolean attribute,
                                 boolean immutable,
                                 boolean relative,
                                 String literal)

Sets an XDI instance under this XDI collection.

Returns:

The XDI instance.

getXdiInstanceUnordered

public U getXdiInstanceUnordered(boolean attribute,
                                 boolean immutable,
                                 boolean relative,
                                 String literal)

gets an XDI instance under this XDI collection.

Returns:

The XDI instance.

getXdiInstancesUnordered

public ReadOnlyIterator<U> getXdiInstancesUnordered()

Returns all XDI instances in this XDI collection.

Specified by:

getXdiInstancesUnordered in interface XdiCollection<EQC extends XdiCollection<EQC,EQI,C,U,O,I>,EQI extends XdiSubGraph<EQI>,C extends XdiCollection<EQC,EQI,C,U,O,I>,U extends XdiInstanceUnordered<EQC,EQI,C,U,O,I>,O extends XdiInstanceOrdered<EQC,EQI,C,U,O,I>,I extends XdiInstance<EQC,EQI,C,U,O,I>>

Returns:

An iterator over all XDI instances.

getXdiInstancesUnorderedCount

public long getXdiInstancesUnorderedCount()

Returns the number of XDI instances in this XDI collection.

Specified by:

getXdiInstancesUnorderedCount in interface XdiCollection<EQC extends XdiCollection<EQC,EQI,C,U,O,I>,EQI extends XdiSubGraph<EQI>,C extends XdiCollection<EQC,EQI,C,U,O,I>,U extends XdiInstanceUnordered<EQC,EQI,C,U,O,I>,O extends XdiInstanceOrdered<EQC,EQI,C,U,O,I>,I extends XdiInstance<EQC,EQI,C,U,O,I>>

setXdiInstanceOrdered

public O setXdiInstanceOrdered(boolean attribute)

Sets an XDI instance under this XDI collection.

Returns:

The XDI instance.

setXdiInstanceOrdered

public O setXdiInstanceOrdered(boolean attribute,
                               long index)

Sets an XDI instance under this XDI collection.

Returns:

The XDI instance.

setXdiInstanceOrdered

public O setXdiInstanceOrdered(boolean attribute,
                               boolean immutable,
                               boolean relative)

Sets an XDI instance under this XDI collection.

Returns:

The XDI instance.

setXdiInstanceOrdered

public O setXdiInstanceOrdered(boolean attribute,
                               boolean immutable,
                               boolean relative,
                               long index)

Sets an XDI instance under this XDI collection.

Returns:

The XDI instance.

getXdiInstanceOrdered

public O getXdiInstanceOrdered(boolean attribute,
                               boolean immutable,
                               boolean relative,
                               long index)

Gets an XDI instance under this XDI collection.

Returns:

The XDI instance.

getXdiInstancesOrdered

public ReadOnlyIterator<O> getXdiInstancesOrdered()

Returns all XDI instances in this XDI collection.

Specified by:

getXdiInstancesOrdered in interface XdiCollection<EQC extends XdiCollection<EQC,EQI,C,U,O,I>,EQI extends XdiSubGraph<EQI>,C extends XdiCollection<EQC,EQI,C,U,O,I>,U extends XdiInstanceUnordered<EQC,EQI,C,U,O,I>,O extends XdiInstanceOrdered<EQC,EQI,C,U,O,I>,I extends XdiInstance<EQC,EQI,C,U,O,I>>

Returns:

An iterator over all XDI instances.

getXdiInstancesOrderedCount

public long getXdiInstancesOrderedCount()

Returns the number of XDI instances in this XDI collection.

Specified by:

getXdiInstancesOrderedCount in interface XdiCollection<EQC extends XdiCollection<EQC,EQI,C,U,O,I>,EQI extends XdiSubGraph<EQI>,C extends XdiCollection<EQC,EQI,C,U,O,I>,U extends XdiInstanceUnordered<EQC,EQI,C,U,O,I>,O extends XdiInstanceOrdered<EQC,EQI,C,U,O,I>,I extends XdiInstance<EQC,EQI,C,U,O,I>>

getXdiInstances

public ReadOnlyIterator<I> getXdiInstances()

Returns all XDI instances and instances in this XDI collection.

Specified by:

getXdiInstances in interface XdiCollection<EQC extends XdiCollection<EQC,EQI,C,U,O,I>,EQI extends XdiSubGraph<EQI>,C extends XdiCollection<EQC,EQI,C,U,O,I>,U extends XdiInstanceUnordered<EQC,EQI,C,U,O,I>,O extends XdiInstanceOrdered<EQC,EQI,C,U,O,I>,I extends XdiInstance<EQC,EQI,C,U,O,I>>

Returns:

An iterator over all XDI instances and instances.

getXdiInstancesDeref

public ReadOnlyIterator<EQI> getXdiInstancesDeref()

Returns all XDI instances and instances in this XDI collection.

Specified by:

getXdiInstancesDeref in interface XdiCollection<EQC extends XdiCollection<EQC,EQI,C,U,O,I>,EQI extends XdiSubGraph<EQI>,C extends XdiCollection<EQC,EQI,C,U,O,I>,U extends XdiInstanceUnordered<EQC,EQI,C,U,O,I>,O extends XdiInstanceOrdered<EQC,EQI,C,U,O,I>,I extends XdiInstance<EQC,EQI,C,U,O,I>>

Returns:

An iterator over all XDI instances and instances.

getC

public Class<C> getC()

getU

public Class<U> getU()

getO

public Class<O> getO()

getI

public Class<I> getI()

createXDIArc

public static XDIArc createXDIArc(Character cs,
                                  boolean attribute,
                                  boolean immutable,
                                  boolean relative,
                                  String literal,
                                  XDIXRef xref)

isValidXDIArc

public static boolean isValidXDIArc(XDIArc XDIarc)