XdiEntityCollection (xdi2-core 0.7.2 API)

java.lang.Object
- xdi2.core.features.nodetypes.XdiAbstractContext<EQ>
- - xdi2.core.features.nodetypes.XdiAbstractSubGraph<EQC>
  - - xdi2.core.features.nodetypes.XdiAbstractCollection<XdiEntityCollection,XdiEntity,XdiEntityCollection,XdiEntityInstanceUnordered,XdiEntityInstanceOrdered,XdiEntityInstance>
    - - xdi2.core.features.nodetypes.XdiEntityCollection

All Implemented Interfaces:

Serializable, Comparable<XdiContext<?>>, XdiCollection<XdiEntityCollection,XdiEntity,XdiEntityCollection,XdiEntityInstanceUnordered,XdiEntityInstanceOrdered,XdiEntityInstance>, XdiContext<XdiEntityCollection>, XdiSubGraph<XdiEntityCollection>

Direct Known Subclasses:

XdiEntityCollection.Definition, XdiEntityCollection.Variable
```
public class XdiEntityCollection
extends XdiAbstractCollection<XdiEntityCollection,XdiEntity,XdiEntityCollection,XdiEntityInstanceUnordered,XdiEntityInstanceOrdered,XdiEntityInstance>
implements XdiCollection<XdiEntityCollection,XdiEntity,XdiEntityCollection,XdiEntityInstanceUnordered,XdiEntityInstanceOrdered,XdiEntityInstance>
```
An XDI entity collection, represented as a context node.

Author:

markus

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`XdiEntityCollection.Definition`
`static class`	`XdiEntityCollection.MappingContextNodeXdiEntityCollectionIterator`
`static class`	`XdiEntityCollection.Variable`

Nested classes/interfaces inherited from class xdi2.core.features.nodetypes.XdiAbstractCollection
XdiAbstractCollection.MappingContextNodeXdiCollectionIterator, XdiAbstractCollection.XdiMembersOrderedIterator, XdiAbstractCollection.XdiMembersUnorderedIterator

Constructor Summary

Constructors
Modifier Constructor and Description

protected XdiEntityCollection(ContextNode contextNode)

Constructors
Modifier	Constructor and Description
`protected`	`XdiEntityCollection(ContextNode contextNode)`

Method Summary

Methods
Modifier and Type	Method and Description
`static XDIArc`	`createXDIArc(Character cs, boolean immutable, boolean relative, String literal, XDIXRef xref)`
`static XDIArc`	`createXDIArc(XDIArc XDIarc)`
`static XdiEntityCollection`	`fromContextNode(ContextNode contextNode)` Factory method that creates an XDI entity collection bound to a given context node.
`static XdiEntityCollection`	`fromXDIAddress(XDIAddress XDIaddress)`
`XdiEntityInstanceOrdered`	`getXdiMemberOrdered(boolean immutable, boolean relative, long index)`
`XdiEntityInstanceUnordered`	`getXdiMemberUnordered(boolean immutable, boolean relative, String literal)`
`static boolean`	`isValid(ContextNode contextNode)` Checks if a context node is a valid XDI entity collection.
`static boolean`	`isValidXDIArc(XDIArc XDIarc)`
`XdiEntityInstanceOrdered`	`setXdiMemberOrdered(boolean immutable, boolean relative)`
`XdiEntityInstanceOrdered`	`setXdiMemberOrdered(boolean immutable, boolean relative, long index)`
`XdiEntityInstanceUnordered`	`setXdiMemberUnordered(boolean immutable, boolean relative)`
`XdiEntityInstanceUnordered`	`setXdiMemberUnordered(boolean immutable, boolean relative, String literal)`

Methods inherited from class xdi2.core.features.nodetypes.XdiAbstractCollection
getC, getI, getO, getU, getXdiMemberOrdered, getXdiMembers, getXdiMembersDeref, getXdiMembersOrdered, getXdiMembersOrderedCount, getXdiMembersUnordered, getXdiMembersUnorderedCount, getXdiMemberUnordered, setXdiMemberOrdered, setXdiMemberOrdered, setXdiMemberUnordered, setXdiMemberUnordered

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface xdi2.core.features.nodetypes.XdiCollection
getXdiMembers, getXdiMembersDeref, getXdiMembersOrdered, getXdiMembersOrderedCount, getXdiMembersUnordered, getXdiMembersUnorderedCount

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, getXdiEntity, getXdiEntity, getXdiEntityCollection, getXdiEntityCollection, getXdiEntitySingleton, getXdiEntitySingleton, getXdiInnerRoot

Methods inherited from interface java.lang.Comparable
compareTo

Constructor Detail

XdiEntityCollection

protected XdiEntityCollection(ContextNode contextNode)

Method Detail

isValid
```
public static boolean isValid(ContextNode contextNode)
```
Checks if a context node is a valid XDI entity collection.

Parameters:
contextNode - The context node to check.

Returns:
True if the context node is a valid XDI entity collection.

fromContextNode
```
public static XdiEntityCollection fromContextNode(ContextNode contextNode)
```
Factory method that creates an XDI entity collection bound to a given context node.

Parameters:
contextNode - The context node that is an XDI entity collection.

Returns:
The XDI entity collection.

fromXDIAddress

public static XdiEntityCollection fromXDIAddress(XDIAddress XDIaddress)

setXdiMemberUnordered
```
public XdiEntityInstanceUnordered setXdiMemberUnordered(boolean immutable,
                                               boolean relative)
```
Specified by:

setXdiMemberUnordered in interface XdiCollection<XdiEntityCollection,XdiEntity,XdiEntityCollection,XdiEntityInstanceUnordered,XdiEntityInstanceOrdered,XdiEntityInstance>

setXdiMemberUnordered

public XdiEntityInstanceUnordered setXdiMemberUnordered(boolean immutable,
                                               boolean relative,
                                               String literal)

Specified by:: setXdiMemberUnordered in interface XdiCollection<XdiEntityCollection,XdiEntity,XdiEntityCollection,XdiEntityInstanceUnordered,XdiEntityInstanceOrdered,XdiEntityInstance>

getXdiMemberUnordered

public XdiEntityInstanceUnordered getXdiMemberUnordered(boolean immutable,
                                               boolean relative,
                                               String literal)

Specified by:: getXdiMemberUnordered in interface XdiCollection<XdiEntityCollection,XdiEntity,XdiEntityCollection,XdiEntityInstanceUnordered,XdiEntityInstanceOrdered,XdiEntityInstance>

setXdiMemberOrdered
```
public XdiEntityInstanceOrdered setXdiMemberOrdered(boolean immutable,
                                           boolean relative)
```
Specified by:

setXdiMemberOrdered in interface XdiCollection<XdiEntityCollection,XdiEntity,XdiEntityCollection,XdiEntityInstanceUnordered,XdiEntityInstanceOrdered,XdiEntityInstance>

setXdiMemberOrdered
```
public XdiEntityInstanceOrdered setXdiMemberOrdered(boolean immutable,
                                           boolean relative,
                                           long index)
```
Specified by:

setXdiMemberOrdered in interface XdiCollection<XdiEntityCollection,XdiEntity,XdiEntityCollection,XdiEntityInstanceUnordered,XdiEntityInstanceOrdered,XdiEntityInstance>

getXdiMemberOrdered
```
public XdiEntityInstanceOrdered getXdiMemberOrdered(boolean immutable,
                                           boolean relative,
                                           long index)
```
Specified by:

getXdiMemberOrdered in interface XdiCollection<XdiEntityCollection,XdiEntity,XdiEntityCollection,XdiEntityInstanceUnordered,XdiEntityInstanceOrdered,XdiEntityInstance>

createXDIArc

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

createXDIArc

public static XDIArc createXDIArc(XDIArc XDIarc)

isValidXDIArc

public static boolean isValidXDIArc(XDIArc XDIarc)

Class XdiEntityCollection

Nested Class Summary

Nested classes/interfaces inherited from class xdi2.core.features.nodetypes.XdiAbstractCollection

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

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

Methods inherited from interface java.lang.Comparable

Constructor Detail

XdiEntityCollection

Method Detail

isValid

fromContextNode

fromXDIAddress

setXdiMemberUnordered

setXdiMemberUnordered

getXdiMemberUnordered

setXdiMemberOrdered

setXdiMemberOrdered

getXdiMemberOrdered

createXDIArc

createXDIArc

isValidXDIArc