xdi2.core

Interface Graph

All Superinterfaces:

Comparable<Graph>, Serializable

All Known Implementing Classes:

AbstractGraph, DummyGraph, JSONGraph, KeyValueGraph, MemoryGraph, WrappedGraph

public interface Graph
extends Serializable, Comparable<Graph>

This interface represents a whole XDI graph. XDI graphs consist of context nodes, relations, and literals. Also, an XDI graph can be expressed as a set of XDI statements.

Author:

markus

Method Summary

Modifier and Type	Method and Description
void	beginTransaction() Starts a new transaction.
void	clear() Clears all data from the graph.
void	close() Closes the graph.
void	commitTransaction() Commits the changes made by the transaction.
boolean	containsStatement(XDIStatement XDIstatement) Check if a statement exists in this graph.
long	getAllStatementCount() Returns the number of all statements in this graph.
ReadOnlyIterator<Statement>	getAllStatements() Gets all statements in this graph.
ContextNode	getDeepContextNode(XDIAddress contextNodeXDIAddress)
ContextNode	getDeepContextNode(XDIAddress contextNodeXDIAddress, boolean subgraph)
LiteralNode	getDeepLiteralNode(XDIAddress literalNodeXDIAddress)
LiteralNode	getDeepLiteralNode(XDIAddress literalNodeXDIAddress, boolean subgraph)
Node	getDeepNode(XDIAddress nodeXDIAddress)
Node	getDeepNode(XDIAddress nodeXDIAddress, boolean subgraph)
Relation	getDeepRelation(XDIAddress contextNodeXDIAddress, XDIAddress XDIaddress)
Relation	getDeepRelation(XDIAddress contextNodeXDIAddress, XDIAddress XDIaddress, XDIAddress targetXDIAddress)
ReadOnlyIterator<Relation>	getDeepRelations(XDIAddress contextNodeXDIAddress, XDIAddress XDIaddress)
GraphFactory	getGraphFactory() Gets the graph factory that created this graph.
String	getIdentifier() Returns an optional identifier to distinguish graphs from one another.
ContextNode	getRootContextNode() Gets the local root context node of this graph.
ContextNode	getRootContextNode(boolean subgraph) Gets the local root context node of this graph.
Statement	getStatement(XDIStatement XDIstatement) Gets a statement in this graph.
boolean	isEmpty() Checks if the graph is empty.
void	rollbackTransaction() Rolls back the changes made by the transaction.
ContextNode	setDeepContextNode(XDIAddress contextNodeXDIAddress)
LiteralNode	setDeepLiteralNode(XDIAddress literalNodeXDIAddress)
Node	setDeepNode(XDIAddress nodeXDIAddress)
Relation	setDeepRelation(XDIAddress contextNodeXDIAddress, XDIAddress XDIaddress, Node targetNode)
Relation	setDeepRelation(XDIAddress contextNodeXDIAddress, XDIAddress XDIaddress, XDIAddress targetXDIAddress)
Statement	setStatement(XDIStatement XDIstatement) Sets a statement in this graph.
boolean	supportsTransactions() Check if this graph supports transactions.
String	toString(MimeType mimeType) Converts the graph to a string in the given MIME type.
String	toString(String format) Converts the graph to a string in the given serialization format.
String	toString(String format, Properties parameters) Converts the graph to a string in the given serialization format.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getGraphFactory

GraphFactory getGraphFactory()

Gets the graph factory that created this graph.

Returns:

The graph factory.

getIdentifier

String getIdentifier()

Returns an optional identifier to distinguish graphs from one another.

Returns:

The graph identifier.

getRootContextNode

ContextNode getRootContextNode(boolean subgraph)

Gets the local root context node of this graph.

Parameters:

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 graph's local root context node.

getRootContextNode

ContextNode getRootContextNode()

Gets the local root context node of this graph.

Returns:

The graph's local root context node.

close

void close()

Closes the graph. This should be called when work on the graph is done.

clear

void clear()

Clears all data from the graph. This is equivalent to calling getRootContextNode().clear();

isEmpty

boolean isEmpty()

Checks if the graph is empty. This is equivalent to calling getRootContextNode().isEmpty();

toString

String toString(String format,
                Properties parameters)

Converts the graph to a string in the given serialization format.

Parameters:

format - The serialization format.

parameters - Parameters for the serialization.

toString

String toString(String format)

Converts the graph to a string in the given serialization format.

Parameters:

format - The serialization format.

toString

String toString(MimeType mimeType)

Converts the graph to a string in the given MIME type.

Parameters:

mimeType - The MIME type.

setDeepNode

Node setDeepNode(XDIAddress nodeXDIAddress)

getDeepNode

Node getDeepNode(XDIAddress nodeXDIAddress,
                 boolean subgraph)

getDeepNode

Node getDeepNode(XDIAddress nodeXDIAddress)

setDeepContextNode

ContextNode setDeepContextNode(XDIAddress contextNodeXDIAddress)

getDeepContextNode

ContextNode getDeepContextNode(XDIAddress contextNodeXDIAddress,
                               boolean subgraph)

getDeepContextNode

ContextNode getDeepContextNode(XDIAddress contextNodeXDIAddress)

setDeepLiteralNode

LiteralNode setDeepLiteralNode(XDIAddress literalNodeXDIAddress)

getDeepLiteralNode

LiteralNode getDeepLiteralNode(XDIAddress literalNodeXDIAddress,
                               boolean subgraph)

getDeepLiteralNode

LiteralNode getDeepLiteralNode(XDIAddress literalNodeXDIAddress)

setDeepRelation

Relation setDeepRelation(XDIAddress contextNodeXDIAddress,
                         XDIAddress XDIaddress,
                         XDIAddress targetXDIAddress)

setDeepRelation

Relation setDeepRelation(XDIAddress contextNodeXDIAddress,
                         XDIAddress XDIaddress,
                         Node targetNode)

getDeepRelation

Relation getDeepRelation(XDIAddress contextNodeXDIAddress,
                         XDIAddress XDIaddress,
                         XDIAddress targetXDIAddress)

getDeepRelation

Relation getDeepRelation(XDIAddress contextNodeXDIAddress,
                         XDIAddress XDIaddress)

getDeepRelations

ReadOnlyIterator<Relation> getDeepRelations(XDIAddress contextNodeXDIAddress,
                                            XDIAddress XDIaddress)

setStatement

Statement setStatement(XDIStatement XDIstatement)

Sets a statement in this graph.

getStatement

Statement getStatement(XDIStatement XDIstatement)

Gets a statement in this graph.

getAllStatements

ReadOnlyIterator<Statement> getAllStatements()

Gets all statements in this graph.

Returns:

An iterator over statements.

containsStatement

boolean containsStatement(XDIStatement XDIstatement)

Check if a statement exists in this graph.

getAllStatementCount

long getAllStatementCount()

Returns the number of all statements in this graph.

Returns:

The number of statements.

supportsTransactions

boolean supportsTransactions()

Check if this graph supports transactions.

beginTransaction

void beginTransaction()

Starts a new transaction.

commitTransaction

void commitTransaction()

Commits the changes made by the transaction.

rollbackTransaction

void rollbackTransaction()

Rolls back the changes made by the transaction.