ContextNode (xdi2-core 0.7.2 API)

All Superinterfaces:

Comparable<ContextNode>, Node, Serializable

All Known Implementing Classes:

AbstractContextNode, DummyContextNode, JSONContextNode, KeyValueContextNode, MemoryContextNode, WrappedContextNode
```
public interface ContextNode
extends Node, Comparable<ContextNode>
```
This interface represents a context node in an XDI graph.

Author:

markus

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clear()` Clears the context node.
`boolean`	`containsContextNode(XDIArc XDIarc)` Checks if a context node with a given arc exists under this context node.
`boolean`	`containsContextNodes()` Checks if this context node has one or more context nodes.
`boolean`	`containsIncomingRelations()` Checks if this context node has one or more incoming relations.
`boolean`	`containsIncomingRelations(XDIAddress XDIaddress)` Checks if incoming relations with a given arc exist in this context node.
`boolean`	`containsLiteralBoolean(Boolean literalData)` Checks if this context node has a literal with the given data.
`boolean`	`containsLiteralNode()` Checks if this context node has a literal.
`boolean`	`containsLiteralNode(Object literalData)` Checks if this context node has a literal with the given data.
`boolean`	`containsLiteralNumber(Double literalData)` Checks if this context node has a literal with the given data.
`boolean`	`containsLiteralString(String literalData)` Checks if this context node has a literal with the given data.
`boolean`	`containsRelation(XDIAddress XDIaddress, XDIAddress targetXDIAddress)` Checks if a relation with a given arc and target context node XRI exists in this context node.
`boolean`	`containsRelations()` Checks if this context node has one or more relations.
`boolean`	`containsRelations(XDIAddress XDIaddress)` Checks if relations with a given arc exist in this context node.
`boolean`	`containsStatement(XDIStatement XDIstatement)` Check if a statement exists in this context node.
`void`	`delContextNode(XDIArc XDIarc)` Deletes the context node with a given arc.
`void`	`delContextNodes()` Deletes all context nodes from this context node.
`void`	`delIncomingRelations()` Deletes the incoming relations of this context node.
`void`	`delLiteralNode()` Deletes the literal from this context node.
`void`	`delRelation(XDIAddress XDIaddress, XDIAddress targetXDIAddress)` Deletes the relation with a given arc from this context node.
`void`	`delRelations()` Deletes all relations from this context node.
`void`	`delRelations(XDIAddress XDIaddress)` Deletes the relation with a given arc from this context node.
`long`	`getAllContextNodeCount()` Returns the number of all context nodes under this context node.
`ReadOnlyIterator<ContextNode>`	`getAllContextNodes()` Returns all context nodes under this context node.
`ReadOnlyIterator<Relation>`	`getAllIncomingRelations()` Returns all incoming relations of this context node.
`ReadOnlyIterator<ContextNode>`	`getAllLeafContextNodes()` Returns all leaf context nodes under this context node.
`long`	`getAllLiteralCount()` Returns the number of all literals of this context node.
`ReadOnlyIterator<LiteralNode>`	`getAllLiterals()` Returns all literals of this context node.
`long`	`getAllRelationCount()` Returns the number of all relations of this context node.
`ReadOnlyIterator<Relation>`	`getAllRelations()` Returns all relations of this context node.
`long`	`getAllStatementCount()` Returns the number of all statements in this context node.
`ReadOnlyIterator<Statement>`	`getAllStatements()` Gets all statements in this context node.
`ContextNode`	`getContextNode(XDIArc XDIarc)` Returns the context node with a given arc.
`ContextNode`	`getContextNode(XDIArc XDIarc, boolean subgraph)` Returns the context node with a given arc.
`long`	`getContextNodeCount()` Returns the number of context nodes under this context node.
`ReadOnlyIterator<ContextNode>`	`getContextNodes()` Returns the context nodes under this context node.
`ContextNode`	`getDeepContextNode(XDIAddress relativeContextNodeXDIAddress)`
`ContextNode`	`getDeepContextNode(XDIAddress relativeContextNodeXDIAddress, boolean subgraph)`
`LiteralNode`	`getDeepLiteralNode(XDIAddress relativeLiteralNodeXDIAddress)`
`LiteralNode`	`getDeepLiteralNode(XDIAddress relativeLiteralNodeXDIAddress, boolean subgraph)`
`Node`	`getDeepNode(XDIAddress relativeNodeXDIAddress)` Returns a node at an arbitrary level of the graph.
`Node`	`getDeepNode(XDIAddress relativeNodeXDIAddress, boolean subgraph)` Returns a node at an arbitrary level of the graph.
`ReadOnlyIterator<Relation>`	`getIncomingRelations()` Returns the incoming relations of this context node.
`ReadOnlyIterator<Relation>`	`getIncomingRelations(XDIAddress XDIaddress)` Returns the incoming relations with a given arc.
`LiteralNode`	`getLiteralBoolean(Boolean literalData)` Returns the literal of this context node.
`LiteralNode`	`getLiteralNode()` Returns the literal of this context node.
`LiteralNode`	`getLiteralNode(Object literalData)` Returns the literal of this context node.
`LiteralNode`	`getLiteralNumber(Double literalData)` Returns the literal of this context node.
`LiteralNode`	`getLiteralString(String literalData)` Returns the literal of this context node.
`Relation`	`getRelation(XDIAddress XDIaddress)` Returns a relation at this context node.
`Relation`	`getRelation(XDIAddress XDIaddress, XDIAddress targetXDIAddress)` Returns a relation at this context node.
`long`	`getRelationCount()` Returns the number of relations of this context node.
`long`	`getRelationCount(XDIAddress XDIaddress)` Returns the number of relations of this context node.
`ReadOnlyIterator<Relation>`	`getRelations()` Returns the relations of this context node.
`ReadOnlyIterator<Relation>`	`getRelations(XDIAddress XDIaddress)` Returns relations at this context node.
`Statement.ContextNodeStatement`	`getStatement()` Gets the statement that represents this context node.
`Statement`	`getStatement(XDIStatement XDIstatement)` Gets a statement in this context node.
`boolean`	`isEmpty()` Checks if the context node is empty.
`boolean`	`isLeafContextNode()` Checks if this context node is a leaf context node.
`boolean`	`isRootContextNode()` Checks if this context node is the root context node.
`ContextNode`	`setContextNode(XDIArc XDIarc)` Creates a new context node and adds it to this context node, or returns an existing context node.
`ContextNode`	`setDeepContextNode(XDIAddress relativeContextNodeXDIAddress)`
`LiteralNode`	`setDeepLiteralNode(XDIAddress relativeLiteralNodeXDIAddress)`
`Node`	`setDeepNode(XDIAddress relativeNodeXDIAddress)` Create a new node at an arbitrary level of the graph, or returns an existing node.
`LiteralNode`	`setLiteralBoolean(Boolean literalData)` Creates a new literal and adds it to this context node, or returns an existing literal.
`LiteralNode`	`setLiteralNode(Object literalData)` Creates a new literal and adds it to this context node, or returns an existing literal.
`LiteralNode`	`setLiteralNumber(Double literalData)` Creates a new literal and adds it to this context node, or returns an existing literal.
`LiteralNode`	`setLiteralString(String literalData)` Creates a new literal and adds it to this context node, or returns an existing literal.
`Relation`	`setRelation(XDIAddress XDIaddress, Node targetNode)` Creates a new relation and adds it to this context node, or returns an existing relation.
`Relation`	`setRelation(XDIAddress XDIarc, XDIAddress targetXDIAddress)` Creates a new relation and adds it to this context node, or returns an existing relation.
`Statement`	`setStatement(XDIStatement XDIstatement)` Sets a statement in this context node.

Methods inherited from interface xdi2.core.Node
delete, getContextNode, getContextNode, getGraph, getXDIAddress, getXDIArc

Methods inherited from interface java.lang.Comparable
compareTo

- Method Detail
  - isRootContextNode
```
boolean isRootContextNode()
```
    Checks if this context node is the root context node.
    
    Returns:
    True, if this context node is the root context node.
  - isLeafContextNode
```
boolean isLeafContextNode()
```
    Checks if this context node is a leaf context node.
    
    Returns:
    True, if this context node is a leaf context node.
  - clear
```
void clear()
```
    Clears the context node. This is equivalent to calling delContextNodes(), delRelations() and delLiteralNode().
  - isEmpty
```
boolean isEmpty()
```
    Checks if the context node is empty. This is equivalent to calling ! ( containsContextNodes() || containsRelations() || containsLiteralNode() ).
  - setContextNode
```
ContextNode setContextNode(XDIArc XDIarc)
```
    Creates a new context node and adds it to this context node, or returns an existing context node.
    
    Parameters:
    arc - The arc of the new or existing context node.
    
    Returns:
    The newly created or existing context node.
  - getContextNode
```
ContextNode getContextNode(XDIArc XDIarc,
                         boolean subgraph)
```
    Returns the context node with a given arc.
    
    Parameters:
    arc - The arc of the context node.
    subgraph - This is simply a hint to the implementation whether child context nodes will subsequently be requested. Implementations may or may not actually use this parameter.
    
    Returns:
    The context node with the given arc, or null.
  - getContextNode
```
ContextNode getContextNode(XDIArc XDIarc)
```
    Returns the context node with a given arc.
    
    Parameters:
    arc - The arc of the context node.
    
    Returns:
    The context node with the given arc, or null.
  - getContextNodes
```
ReadOnlyIterator<ContextNode> getContextNodes()
```
    Returns the context nodes under this context node.
    
    Returns:
    An iterator over context nodes.
  - getAllContextNodes
```
ReadOnlyIterator<ContextNode> getAllContextNodes()
```
    Returns all context nodes under this context node.
    
    Returns:
    An iterator over context nodes.
  - getAllLeafContextNodes
```
ReadOnlyIterator<ContextNode> getAllLeafContextNodes()
```
    Returns all leaf context nodes under this context node.
    
    Returns:
    An iterator over leaf context nodes.
  - containsContextNode
```
boolean containsContextNode(XDIArc XDIarc)
```
    Checks if a context node with a given arc exists under this context node.
    
    Parameters:
    arc - The arc to look for.
    
    Returns:
    True if this context node has a context node with the given arc.
  - containsContextNodes
```
boolean containsContextNodes()
```
    Checks if this context node has one or more context nodes.
    
    Returns:
    True if this context node has context nodes.
  - delContextNode
```
void delContextNode(XDIArc XDIarc)
```
    Deletes the context node with a given arc.
    
    Parameters:
    arc - The arc of the context node.
  - delContextNodes
```
void delContextNodes()
```
    Deletes all context nodes from this context node.
  - getContextNodeCount
```
long getContextNodeCount()
```
    Returns the number of context nodes under this context node.
    
    Returns:
    The number of context nodes.
  - getAllContextNodeCount
```
long getAllContextNodeCount()
```
    Returns the number of all context nodes under this context node.
    
    Returns:
    The number of context nodes.
  - setRelation
```
Relation setRelation(XDIAddress XDIarc,
                   XDIAddress targetXDIAddress)
```
    Creates a new relation and adds it to this context node, or returns an existing relation.
    
    Parameters:
    XDIarc - The arc of the relation.
    targetXDIAddress - The target context node address of the relation.
    
    Returns:
    The newly created or existing relation.
  - setRelation
```
Relation setRelation(XDIAddress XDIaddress,
                   Node targetNode)
```
    Creates a new relation and adds it to this context node, or returns an existing relation.
    
    Parameters:
    arc - The arc of the relation.
    targetContextNode - The target context node of the relation.
    
    Returns:
    The newly created or existing relation.
  - getRelation
```
Relation getRelation(XDIAddress XDIaddress,
                   XDIAddress targetXDIAddress)
```
    Returns a relation at this context node.
    
    Parameters:
    arc - The arc to look for.
    targetXDIAddress - The target context node XRI of the relation.
    
    Returns:
    The relation with the given arc, or null.
  - getRelation
```
Relation getRelation(XDIAddress XDIaddress)
```
    Returns a relation at this context node.
    
    Parameters:
    arc - The arc to look for.
    
    Returns:
    The relation with the given arc, or null.
  - getRelations
```
ReadOnlyIterator<Relation> getRelations(XDIAddress XDIaddress)
```
    Returns relations at this context node.
    
    Parameters:
    arc - The arc to look for.
    
    Returns:
    An iterator over relations with the given arc, or null.
  - getRelations
```
ReadOnlyIterator<Relation> getRelations()
```
    Returns the relations of this context node.
    
    Returns:
    An iterator over relations.
  - getIncomingRelations
```
ReadOnlyIterator<Relation> getIncomingRelations(XDIAddress XDIaddress)
```
    Returns the incoming relations with a given arc.
    
    Parameters:
    arc - The arc to look for.
    
    Returns:
    An iterator over relations with the given arc, or null.
  - getIncomingRelations
```
ReadOnlyIterator<Relation> getIncomingRelations()
```
    Returns the incoming relations of this context node.
    
    Returns:
    An iterator over relations.
  - getAllRelations
```
ReadOnlyIterator<Relation> getAllRelations()
```
    Returns all relations of this context node.
    
    Returns:
    An iterator over relations.
  - getAllIncomingRelations
```
ReadOnlyIterator<Relation> getAllIncomingRelations()
```
    Returns all incoming relations of this context node.
    
    Returns:
    An iterator over relations.
  - containsRelation
```
boolean containsRelation(XDIAddress XDIaddress,
                       XDIAddress targetXDIAddress)
```
    Checks if a relation with a given arc and target context node XRI exists in this context node.
    
    Parameters:
    arc - The arc of the relations.
    targetXDIAddress - The target context node XRI of the relation.
    
    Returns:
    True if this context node has a relation with the given arc and target context node XRI.
  - containsRelations
```
boolean containsRelations(XDIAddress XDIaddress)
```
    Checks if relations with a given arc exist in this context node.
    
    Parameters:
    arc - The arc of the relations.
    
    Returns:
    True if this context node has relations with the given arc.
  - containsRelations
```
boolean containsRelations()
```
    Checks if this context node has one or more relations.
    
    Returns:
    True if this context node has relations.
  - containsIncomingRelations
```
boolean containsIncomingRelations(XDIAddress XDIaddress)
```
    Checks if incoming relations with a given arc exist in this context node.
    
    Parameters:
    arc - The arc of the incoming relations.
    
    Returns:
    True if this context node has incoming relations with the given arc.
  - containsIncomingRelations
```
boolean containsIncomingRelations()
```
    Checks if this context node has one or more incoming relations.
    
    Returns:
    True if this context node has incoming relations.
  - delRelation
```
void delRelation(XDIAddress XDIaddress,
               XDIAddress targetXDIAddress)
```
    Deletes the relation with a given arc from this context node.
    
    Parameters:
    arc - The arc of the relation.
    targetXDIAddress - The target context node XRI of the relation.
  - delRelations
```
void delRelations(XDIAddress XDIaddress)
```
    Deletes the relation with a given arc from this context node.
    
    Parameters:
    arc - The arc of the relation.
  - delRelations
```
void delRelations()
```
    Deletes all relations from this context node.
  - delIncomingRelations
```
void delIncomingRelations()
```
    Deletes the incoming relations of this context node.
  - getRelationCount
```
long getRelationCount(XDIAddress XDIaddress)
```
    Returns the number of relations of this context node.
    
    Parameters:
    arc - The arc to look for.
    
    Returns:
    The number of relations.
  - getRelationCount
```
long getRelationCount()
```
    Returns the number of relations of this context node.
    
    Returns:
    The number of relations.
  - getAllRelationCount
```
long getAllRelationCount()
```
    Returns the number of all relations of this context node.
    
    Returns:
    The number of relations.
  - setLiteralNode
```
LiteralNode setLiteralNode(Object literalData)
```
    Creates a new literal and adds it to this context node, or returns an existing literal.
    
    Parameters:
    literalData - The literal data associated with the literal.
    
    Returns:
    The newly created or existing literal.
  - setLiteralString
```
LiteralNode setLiteralString(String literalData)
```
    Creates a new literal and adds it to this context node, or returns an existing literal.
    
    Parameters:
    literalData - The literal data string associated with the literal.
    
    Returns:
    The newly created or existing literal.
  - setLiteralNumber
```
LiteralNode setLiteralNumber(Double literalData)
```
    Creates a new literal and adds it to this context node, or returns an existing literal.
    
    Parameters:
    literalData - The literal data number associated with the literal.
    
    Returns:
    The newly created or existing literal.
  - setLiteralBoolean
```
LiteralNode setLiteralBoolean(Boolean literalData)
```
    Creates a new literal and adds it to this context node, or returns an existing literal.
    
    Parameters:
    literalData - The literal data boolean associated with the literal.
    
    Returns:
    The newly created or existing literal.
  - getLiteralNode
```
LiteralNode getLiteralNode()
```
    Returns the literal of this context node.
    
    Returns:
    The literal.
  - getLiteralNode
```
LiteralNode getLiteralNode(Object literalData)
```
    Returns the literal of this context node.
    
    Parameters:
    literalData - The literal data associated with the literal.
    
    Returns:
    The literal.
  - getLiteralString
```
LiteralNode getLiteralString(String literalData)
```
    Returns the literal of this context node.
    
    Parameters:
    literalData - The literal data string associated with the literal.
    
    Returns:
    The literal.
  - getLiteralNumber
```
LiteralNode getLiteralNumber(Double literalData)
```
    Returns the literal of this context node.
    
    Parameters:
    literalData - The literal data number associated with the literal.
    
    Returns:
    The literal.
  - getLiteralBoolean
```
LiteralNode getLiteralBoolean(Boolean literalData)
```
    Returns the literal of this context node.
    
    Parameters:
    literalData - The literal data boolean associated with the literal.
    
    Returns:
    The literal.
  - getAllLiterals
```
ReadOnlyIterator<LiteralNode> getAllLiterals()
```
    Returns all literals of this context node.
    
    Returns:
    An iterator over literals.
  - containsLiteralNode
```
boolean containsLiteralNode(Object literalData)
```
    Checks if this context node has a literal with the given data.
    
    Parameters:
    literalData - The literal data associated with the literal.
    
    Returns:
    True if this context node has a literal with the given data.
  - containsLiteralString
```
boolean containsLiteralString(String literalData)
```
    Checks if this context node has a literal with the given data.
    
    Parameters:
    literalData - The literal data string associated with the literal.
    
    Returns:
    True if this context node has a literal with the given data.
  - containsLiteralNumber
```
boolean containsLiteralNumber(Double literalData)
```
    Checks if this context node has a literal with the given data.
    
    Parameters:
    literalData - The literal data number associated with the literal.
    
    Returns:
    True if this context node has a literal with the given data.
  - containsLiteralBoolean
```
boolean containsLiteralBoolean(Boolean literalData)
```
    Checks if this context node has a literal with the given data.
    
    Parameters:
    literalData - The literal data boolean associated with the literal.
    
    Returns:
    True if this context node has a literal with the given data.
  - containsLiteralNode
```
boolean containsLiteralNode()
```
    Checks if this context node has a literal.
    
    Returns:
    True if this context node has a literal.
  - delLiteralNode
```
void delLiteralNode()
```
    Deletes the literal from this context node.
  - getAllLiteralCount
```
long getAllLiteralCount()
```
    Returns the number of all literals of this context node.
    
    Returns:
    The number of literals.
  - setDeepNode
```
Node setDeepNode(XDIAddress relativeNodeXDIAddress)
```
    Create a new node at an arbitrary level of the graph, or returns an existing node.
    
    Parameters:
    relativeNodeXDIAddress - The relative address of the new or existing node.
    
    Returns:
    The newly created or existing node.
  - setDeepContextNode
```
ContextNode setDeepContextNode(XDIAddress relativeContextNodeXDIAddress)
```
  - setDeepLiteralNode
```
LiteralNode setDeepLiteralNode(XDIAddress relativeLiteralNodeXDIAddress)
```
  - getDeepNode
```
Node getDeepNode(XDIAddress relativeNodeXDIAddress,
               boolean subgraph)
```
    Returns a node at an arbitrary level of the graph.
    
    Parameters:
    relativeNodeXDIAddress - The relative address of the node.
    subgraph - This is simply a hint to the implementation whether child context nodes will subsequently be requested. Implementations may or may not actually use this parameter.
    
    Returns:
    The node with the given address, or null.
  - getDeepContextNode
```
ContextNode getDeepContextNode(XDIAddress relativeContextNodeXDIAddress,
                             boolean subgraph)
```
  - getDeepLiteralNode
```
LiteralNode getDeepLiteralNode(XDIAddress relativeLiteralNodeXDIAddress,
                             boolean subgraph)
```
  - getDeepNode
```
Node getDeepNode(XDIAddress relativeNodeXDIAddress)
```
    Returns a node at an arbitrary level of the graph.
    
    Parameters:
    relativeNodeXDIAddress - The relative address of the node.
    
    Returns:
    The node with the given address, or null.
  - getDeepContextNode
```
ContextNode getDeepContextNode(XDIAddress relativeContextNodeXDIAddress)
```
  - getDeepLiteralNode
```
LiteralNode getDeepLiteralNode(XDIAddress relativeLiteralNodeXDIAddress)
```
  - getStatement
```
Statement.ContextNodeStatement getStatement()
```
    Gets the statement that represents this context node.
    
    Returns:
    A statement.
  - setStatement
```
Statement setStatement(XDIStatement XDIstatement)
```
    Sets a statement in this context node.
  - getStatement
```
Statement getStatement(XDIStatement XDIstatement)
```
    Gets a statement in this context node.
  - getAllStatements
```
ReadOnlyIterator<Statement> getAllStatements()
```
    Gets all statements in this context node.
    
    Returns:
    An iterator over statements.
  - containsStatement
```
boolean containsStatement(XDIStatement XDIstatement)
```
    Check if a statement exists in this context node.
  - getAllStatementCount
```
long getAllStatementCount()
```
    Returns the number of all statements in this context node.
    
    Returns:
    The number of statements.

Interface ContextNode

Method Summary

Methods inherited from interface xdi2.core.Node

Methods inherited from interface java.lang.Comparable

Method Detail

isRootContextNode

isLeafContextNode

clear

isEmpty

setContextNode

getContextNode

getContextNode

getContextNodes

getAllContextNodes

getAllLeafContextNodes

containsContextNode

containsContextNodes

delContextNode

delContextNodes

getContextNodeCount

getAllContextNodeCount

setRelation

setRelation

getRelation

getRelation

getRelations

getRelations

getIncomingRelations

getIncomingRelations

getAllRelations

getAllIncomingRelations

containsRelation

containsRelations

containsRelations

containsIncomingRelations

containsIncomingRelations

delRelation

delRelations

delRelations

delIncomingRelations

getRelationCount

getRelationCount

getAllRelationCount

setLiteralNode

setLiteralString

setLiteralNumber

setLiteralBoolean

getLiteralNode

getLiteralNode

getLiteralString

getLiteralNumber

getLiteralBoolean

getAllLiterals

containsLiteralNode

containsLiteralString

containsLiteralNumber

containsLiteralBoolean

containsLiteralNode

delLiteralNode

getAllLiteralCount

setDeepNode

setDeepContextNode

setDeepLiteralNode

getDeepNode

getDeepContextNode

getDeepLiteralNode

getDeepNode

getDeepContextNode

getDeepLiteralNode

getStatement

setStatement

getStatement

getAllStatements

containsStatement

getAllStatementCount