XdiAbstractRoot (xdi2-core 0.7.2 API)

java.lang.Object
- xdi2.core.features.nodetypes.XdiAbstractContext<XdiRoot>
- - xdi2.core.features.nodetypes.XdiAbstractRoot

All Implemented Interfaces:

Serializable, Comparable<XdiContext<?>>, XdiContext<XdiRoot>, XdiRoot

Direct Known Subclasses:

XdiCommonRoot, XdiInnerRoot, XdiPeerRoot
```
public abstract class XdiAbstractRoot
extends XdiAbstractContext<XdiRoot>
implements XdiRoot
```
See Also:
Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface xdi2.core.features.nodetypes.XdiRoot
  XdiRoot.MappingAbsoluteToRelativeXDIAddressIterator, XdiRoot.MappingAbsoluteToRelativeXDIStatementIterator, XdiRoot.MappingRelativeToAbsoluteXDIAddressIterator, XdiRoot.MappingRelativeToAbsoluteXDIStatementIterator

Constructor Summary

Constructors
Constructor and Description

XdiAbstractRoot(ContextNode contextNode)

Constructors
Constructor and Description
`XdiAbstractRoot(ContextNode contextNode)`

Method Summary

Methods
Modifier and Type	Method and Description
`XDIAddress`	`absoluteToRelativeXDIAddress(XDIAddress absoluteAddress)`
`XDIStatement`	`absoluteToRelativeXDIStatement(XDIStatement absoluteStatementAddress)`
`static XdiRoot`	`fromContextNode(ContextNode contextNode)` Factory method that creates an XDI root bound to a given context node.
`static XdiRoot`	`fromXDIAddress(XDIAddress XDIaddress)`
`XdiInnerRoot`	`getInnerRoot(XDIAddress subject, XDIAddress predicate, boolean create)` Returns an XDI inner root under this XDI root.
`ReadOnlyIterator<XdiInnerRoot>`	`getInnerRoots()` Returns the XDI inner roots under this XDI root
`XdiPeerRoot`	`getPeerRoot(XDIAddress XDIaddress, boolean create)` Returns an XDI peer root under this XDI root.
`ReadOnlyIterator<XdiPeerRoot>`	`getPeerRoots()` Returns the XDI peer roots under this XDI root
`XdiRoot`	`getRoot(XDIAddress XDIaddress, boolean create)` Returns an XDI root under this XDI root.
`static boolean`	`isValid(ContextNode contextNode)` Checks if a context node is a valid XDI root.
`static boolean`	`isValidXDIArc(XDIArc XDIarc)`
`XDIAddress`	`relativeToAbsoluteXDIAddress(XDIAddress relativeAddress)`
`XDIStatement`	`relativeToAbsoluteXDIStatement(XDIStatement relativeStatementAddress)`

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

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
  - XdiAbstractRoot
```
public XdiAbstractRoot(ContextNode contextNode)
```
- Method Detail
  - isValid
```
public static boolean isValid(ContextNode contextNode)
```
    Checks if a context node is a valid XDI root.
    
    Parameters:
    contextNode - The context node to check.
    
    Returns:
    True if the context node is a valid XDI root.
  - fromContextNode
```
public static XdiRoot fromContextNode(ContextNode contextNode)
```
    Factory method that creates an XDI root bound to a given context node.
    
    Parameters:
    contextNode - The context node that is an XDI root.
    
    Returns:
    The XDI root.
  - fromXDIAddress
```
public static XdiRoot fromXDIAddress(XDIAddress XDIaddress)
```
  - getPeerRoots
```
public ReadOnlyIterator<XdiPeerRoot> getPeerRoots()
```
    Description copied from interface: XdiRoot
    
    Returns the XDI peer roots under this XDI root
    
    Specified by:
    
    getPeerRoots in interface XdiRoot
    
    Returns:
    The XDI peer roots.
  - getInnerRoots
```
public ReadOnlyIterator<XdiInnerRoot> getInnerRoots()
```
    Description copied from interface: XdiRoot
    
    Returns the XDI inner roots under this XDI root
    
    Specified by:
    
    getInnerRoots in interface XdiRoot
    
    Returns:
    The XDI inner roots.
  - getPeerRoot
```
public XdiPeerRoot getPeerRoot(XDIAddress XDIaddress,
                      boolean create)
```
    Description copied from interface: XdiRoot
    
    Returns an XDI peer root under this XDI root.
    
    Specified by:
    
    getPeerRoot in interface XdiRoot
    
    create - Whether the XDI peer root should be created, if it does not exist.
    
    Returns:
    The XDI peer root.
  - getInnerRoot
```
public XdiInnerRoot getInnerRoot(XDIAddress subject,
                        XDIAddress predicate,
                        boolean create)
```
    Description copied from interface: XdiRoot
    
    Returns an XDI inner root under this XDI root.
    
    Specified by:
    
    getInnerRoot in interface XdiRoot
    
    Parameters:
    subject - The subject address whose XDI inner root to find.
    predicate - The predicate address whose XDI inner root to find.
    create - Whether the XDI inner root should be created, if it does not exist.
    
    Returns:
    The XDI inner root.
  - getRoot
```
public XdiRoot getRoot(XDIAddress XDIaddress,
              boolean create)
```
    Description copied from interface: XdiRoot
    
    Returns an XDI root under this XDI root.
    
    Specified by:
    
    getRoot in interface XdiRoot
    
    create - Whether the XDI root should be created, if it does not exist.
    
    Returns:
    The XDI root.
  - absoluteToRelativeXDIAddress
```
public XDIAddress absoluteToRelativeXDIAddress(XDIAddress absoluteAddress)
```
    Specified by:
    
    absoluteToRelativeXDIAddress in interface XdiRoot
  - relativeToAbsoluteXDIAddress
```
public XDIAddress relativeToAbsoluteXDIAddress(XDIAddress relativeAddress)
```
    Specified by:
    
    relativeToAbsoluteXDIAddress in interface XdiRoot
  - absoluteToRelativeXDIStatement
```
public XDIStatement absoluteToRelativeXDIStatement(XDIStatement absoluteStatementAddress)
```
    Specified by:
    
    absoluteToRelativeXDIStatement in interface XdiRoot
  - relativeToAbsoluteXDIStatement
```
public XDIStatement relativeToAbsoluteXDIStatement(XDIStatement relativeStatementAddress)
```
    Specified by:
    
    relativeToAbsoluteXDIStatement in interface XdiRoot
  - isValidXDIArc
```
public static boolean isValidXDIArc(XDIArc XDIarc)
```

Class XdiAbstractRoot

Nested Class Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Comparable

Constructor Detail

XdiAbstractRoot

Method Detail

isValid

fromContextNode

fromXDIAddress

getPeerRoots

getInnerRoots

getPeerRoot

getInnerRoot

getRoot

absoluteToRelativeXDIAddress

relativeToAbsoluteXDIAddress

absoluteToRelativeXDIStatement

relativeToAbsoluteXDIStatement

isValidXDIArc