KeyValueContextNode (xdi2-core 0.7.2 API)

java.lang.Object
- xdi2.core.impl.AbstractNode
- - xdi2.core.impl.AbstractContextNode
  - - xdi2.core.impl.keyvalue.KeyValueContextNode

All Implemented Interfaces:

Serializable, Comparable<ContextNode>, ContextNode, Node
```
public class KeyValueContextNode
extends AbstractContextNode
implements ContextNode
```
See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description
`KeyValueContextNode(KeyValueGraph graph, KeyValueContextNode contextNode, KeyValueStore keyValueStore, String key, XDIArc XDIarc)`

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`	`containsLiteralNode()` Checks if this context node has a literal.
`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.
`void`	`delContextNode(XDIArc XDIarc)` Deletes the context node with a given arc.
`void`	`delContextNodes()` Deletes all context nodes from 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.
`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.
`LiteralNode`	`getLiteralNode()` 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.
`XDIArc`	`getXDIArc()` Every node has an associated arc.
`ContextNode`	`setContextNode(XDIArc XDIarc)` Creates a new context node and adds it to this context node, or returns an existing context node.
`LiteralNode`	`setLiteralNode(Object 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.

Methods inherited from class xdi2.core.impl.AbstractContextNode
compareTo, containsIncomingRelations, containsIncomingRelations, containsLiteralBoolean, containsLiteralNode, containsLiteralNumber, containsLiteralString, containsStatement, delContextNodeDelAllIncomingRelations, delContextNodeDelAllInnerRoots, delContextNodeDelAllRelations, delete, delIncomingRelations, delRelationDelInnerRoot, equals, getAllContextNodeCount, getAllContextNodes, getAllIncomingRelations, getAllLeafContextNodes, getAllLiteralCount, getAllLiterals, getAllRelationCount, getAllRelations, getAllStatementCount, getAllStatements, getContextNode, getDeepContextNode, getDeepContextNode, getDeepLiteralNode, getDeepLiteralNode, getDeepNode, getDeepNode, getGraph, getIncomingRelations, getIncomingRelations, getLiteralBoolean, getLiteralNode, getLiteralNumber, getLiteralString, getStatement, getStatement, hashCode, isEmpty, isLeafContextNode, isRootContextNode, setContextNodeCheckValid, setContextNodeSetInnerRoot, setDeepContextNode, setDeepLiteralNode, setDeepNode, setLiteralBoolean, setLiteralCheckValid, setLiteralNumber, setLiteralString, setRelation, setRelationCheckValid, setRelationSetTargetNode, setStatement, toString

Methods inherited from class xdi2.core.impl.AbstractNode
getContextNode, getContextNode, getXDIAddress

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

Methods inherited from interface xdi2.core.ContextNode
containsIncomingRelations, containsIncomingRelations, containsLiteralBoolean, containsLiteralNode, containsLiteralNumber, containsLiteralString, containsStatement, delIncomingRelations, getAllContextNodeCount, getAllContextNodes, getAllIncomingRelations, getAllLeafContextNodes, getAllLiteralCount, getAllLiterals, getAllRelationCount, getAllRelations, getAllStatementCount, getAllStatements, getContextNode, getDeepContextNode, getDeepContextNode, getDeepLiteralNode, getDeepLiteralNode, getDeepNode, getDeepNode, getIncomingRelations, getIncomingRelations, getLiteralBoolean, getLiteralNode, getLiteralNumber, getLiteralString, getStatement, getStatement, isEmpty, isLeafContextNode, isRootContextNode, setDeepContextNode, setDeepLiteralNode, setDeepNode, setLiteralBoolean, setLiteralNumber, setLiteralString, setRelation, setStatement

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

Methods inherited from interface java.lang.Comparable
compareTo

- Constructor Detail
  - KeyValueContextNode
```
public KeyValueContextNode(KeyValueGraph graph,
                   KeyValueContextNode contextNode,
                   KeyValueStore keyValueStore,
                   String key,
                   XDIArc XDIarc)
```
- Method Detail
  - clear
```
public void clear()
```
    Description copied from interface: ContextNode
    
    Clears the context node. This is equivalent to calling delContextNodes(), delRelations() and delLiteralNode().
    
    Specified by:
    
    clear in interface ContextNode
    
    Overrides:
    
    clear in class AbstractContextNode
  - getXDIArc
```
public XDIArc getXDIArc()
```
    Description copied from interface: Node
    
    Every node has an associated arc. This returns null for the root context node.
    
    Specified by:
    
    getXDIArc in interface Node
    
    Returns:
    The arc associated with this node.
  - setContextNode
```
public ContextNode setContextNode(XDIArc XDIarc)
```
    Description copied from interface: ContextNode
    
    Creates a new context node and adds it to this context node, or returns an existing context node.
    
    Specified by:
    
    setContextNode in interface ContextNode
    
    Returns:
    The newly created or existing context node.
  - getContextNodes
```
public ReadOnlyIterator<ContextNode> getContextNodes()
```
    Description copied from interface: ContextNode
    
    Returns the context nodes under this context node.
    
    Specified by:
    
    getContextNodes in interface ContextNode
    
    Returns:
    An iterator over context nodes.
  - getContextNode
```
public ContextNode getContextNode(XDIArc XDIarc,
                         boolean subgraph)
```
    Description copied from interface: ContextNode
    
    Returns the context node with a given arc.
    
    Specified by:
    
    getContextNode in interface ContextNode
    
    Overrides:
    
    getContextNode in class AbstractContextNode
    
    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.
  - containsContextNode
```
public boolean containsContextNode(XDIArc XDIarc)
```
    Description copied from interface: ContextNode
    
    Checks if a context node with a given arc exists under this context node.
    
    Specified by:
    
    containsContextNode in interface ContextNode
    
    Overrides:
    
    containsContextNode in class AbstractContextNode
    
    Returns:
    True if this context node has a context node with the given arc.
  - containsContextNodes
```
public boolean containsContextNodes()
```
    Description copied from interface: ContextNode
    
    Checks if this context node has one or more context nodes.
    
    Specified by:
    
    containsContextNodes in interface ContextNode
    
    Overrides:
    
    containsContextNodes in class AbstractContextNode
    
    Returns:
    True if this context node has context nodes.
  - delContextNode
```
public void delContextNode(XDIArc XDIarc)
```
    Description copied from interface: ContextNode
    
    Deletes the context node with a given arc.
    
    Specified by:
    
    delContextNode in interface ContextNode
  - delContextNodes
```
public void delContextNodes()
```
    Description copied from interface: ContextNode
    
    Deletes all context nodes from this context node.
    
    Specified by:
    
    delContextNodes in interface ContextNode
    
    Overrides:
    
    delContextNodes in class AbstractContextNode
  - getContextNodeCount
```
public long getContextNodeCount()
```
    Description copied from interface: ContextNode
    
    Returns the number of context nodes under this context node.
    
    Specified by:
    
    getContextNodeCount in interface ContextNode
    
    Overrides:
    
    getContextNodeCount in class AbstractContextNode
    
    Returns:
    The number of context nodes.
  - setRelation
```
public Relation setRelation(XDIAddress XDIaddress,
                   Node targetNode)
```
    Description copied from interface: ContextNode
    
    Creates a new relation and adds it to this context node, or returns an existing relation.
    
    Specified by:
    
    setRelation in interface ContextNode
    
    Returns:
    The newly created or existing relation.
  - getRelation
```
public Relation getRelation(XDIAddress XDIaddress,
                   XDIAddress targetXDIAddress)
```
    Description copied from interface: ContextNode
    
    Returns a relation at this context node.
    
    Specified by:
    
    getRelation in interface ContextNode
    
    Overrides:
    
    getRelation in class AbstractContextNode
    
    targetXDIAddress - The target context node XRI of the relation.
    
    Returns:
    The relation with the given arc, or null.
  - getRelation
```
public Relation getRelation(XDIAddress XDIaddress)
```
    Description copied from interface: ContextNode
    
    Returns a relation at this context node.
    
    Specified by:
    
    getRelation in interface ContextNode
    
    Overrides:
    
    getRelation in class AbstractContextNode
    
    Returns:
    The relation with the given arc, or null.
  - getRelations
```
public ReadOnlyIterator<Relation> getRelations(XDIAddress XDIaddress)
```
    Description copied from interface: ContextNode
    
    Returns relations at this context node.
    
    Specified by:
    
    getRelations in interface ContextNode
    
    Overrides:
    
    getRelations in class AbstractContextNode
    
    Returns:
    An iterator over relations with the given arc, or null.
  - getRelations
```
public ReadOnlyIterator<Relation> getRelations()
```
    Description copied from interface: ContextNode
    
    Returns the relations of this context node.
    
    Specified by:
    
    getRelations in interface ContextNode
    
    Returns:
    An iterator over relations.
  - containsRelation
```
public boolean containsRelation(XDIAddress XDIaddress,
                       XDIAddress targetXDIAddress)
```
    Description copied from interface: ContextNode
    
    Checks if a relation with a given arc and target context node XRI exists in this context node.
    
    Specified by:
    
    containsRelation in interface ContextNode
    
    Overrides:
    
    containsRelation in class AbstractContextNode
    
    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
```
public boolean containsRelations(XDIAddress XDIaddress)
```
    Description copied from interface: ContextNode
    
    Checks if relations with a given arc exist in this context node.
    
    Specified by:
    
    containsRelations in interface ContextNode
    
    Overrides:
    
    containsRelations in class AbstractContextNode
    
    Returns:
    True if this context node has relations with the given arc.
  - containsRelations
```
public boolean containsRelations()
```
    Description copied from interface: ContextNode
    
    Checks if this context node has one or more relations.
    
    Specified by:
    
    containsRelations in interface ContextNode
    
    Overrides:
    
    containsRelations in class AbstractContextNode
    
    Returns:
    True if this context node has relations.
  - delRelation
```
public void delRelation(XDIAddress XDIaddress,
               XDIAddress targetXDIAddress)
```
    Description copied from interface: ContextNode
    
    Deletes the relation with a given arc from this context node.
    
    Specified by:
    
    delRelation in interface ContextNode
    
    targetXDIAddress - The target context node XRI of the relation.
  - delRelations
```
public void delRelations(XDIAddress XDIaddress)
```
    Description copied from interface: ContextNode
    
    Deletes the relation with a given arc from this context node.
    
    Specified by:
    
    delRelations in interface ContextNode
    
    Overrides:
    
    delRelations in class AbstractContextNode
  - delRelations
```
public void delRelations()
```
    Description copied from interface: ContextNode
    
    Deletes all relations from this context node.
    
    Specified by:
    
    delRelations in interface ContextNode
    
    Overrides:
    
    delRelations in class AbstractContextNode
  - getRelationCount
```
public long getRelationCount()
```
    Description copied from interface: ContextNode
    
    Returns the number of relations of this context node.
    
    Specified by:
    
    getRelationCount in interface ContextNode
    
    Overrides:
    
    getRelationCount in class AbstractContextNode
    
    Returns:
    The number of relations.
  - getRelationCount
```
public long getRelationCount(XDIAddress XDIaddress)
```
    Description copied from interface: ContextNode
    
    Returns the number of relations of this context node.
    
    Specified by:
    
    getRelationCount in interface ContextNode
    
    Overrides:
    
    getRelationCount in class AbstractContextNode
    
    Returns:
    The number of relations.
  - setLiteralNode
```
public LiteralNode setLiteralNode(Object literalData)
```
    Description copied from interface: ContextNode
    
    Creates a new literal and adds it to this context node, or returns an existing literal.
    
    Specified by:
    
    setLiteralNode in interface ContextNode
    
    Parameters:
    literalData - The literal data associated with the literal.
    
    Returns:
    The newly created or existing literal.
  - getLiteralNode
```
public LiteralNode getLiteralNode()
```
    Description copied from interface: ContextNode
    
    Returns the literal of this context node.
    
    Specified by:
    
    getLiteralNode in interface ContextNode
    
    Returns:
    The literal.
  - containsLiteralNode
```
public boolean containsLiteralNode()
```
    Description copied from interface: ContextNode
    
    Checks if this context node has a literal.
    
    Specified by:
    
    containsLiteralNode in interface ContextNode
    
    Overrides:
    
    containsLiteralNode in class AbstractContextNode
    
    Returns:
    True if this context node has a literal.
  - delLiteralNode
```
public void delLiteralNode()
```
    Description copied from interface: ContextNode
    
    Deletes the literal from this context node.
    
    Specified by:
    
    delLiteralNode in interface ContextNode

Class KeyValueContextNode

Constructor Summary

Method Summary

Methods inherited from class xdi2.core.impl.AbstractContextNode

Methods inherited from class xdi2.core.impl.AbstractNode

Methods inherited from class java.lang.Object

Methods inherited from interface xdi2.core.ContextNode

Methods inherited from interface xdi2.core.Node

Methods inherited from interface java.lang.Comparable

Constructor Detail

KeyValueContextNode

Method Detail

clear

getXDIArc

setContextNode

getContextNodes

getContextNode

containsContextNode

containsContextNodes

delContextNode

delContextNodes

getContextNodeCount

setRelation

getRelation

getRelation

getRelations

getRelations

containsRelation

containsRelations

containsRelations

delRelation

delRelations

delRelations

getRelationCount

getRelationCount

setLiteralNode

getLiteralNode

containsLiteralNode

delLiteralNode