|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectstory.dbcore.admin.Document
public class Document
Container and manager for a set of nodes (separated into different
NodeRepositories) and the links between them (stored in a single
LinkRepository). Akin to a document of a word processor.
Despite its importance, this class should not be
instantiated or handled by anything other than a DBCoreInterface. If
you'd like to access any of these functions, construct a Command
and pass it to the DBCoreInterface.
Method Summary | |
---|---|
NodeAddress |
findNodeAddress(NodeID nodeID)
Find a node by its ID. |
DocumentID |
getID()
Get the string identifier for this Document. |
RelatedNodes |
getLinksOfNode(NodeAddress nodeAddress,
LinkType linkType,
LinkDirection direction)
Get a RelatedNodes object through which you could query the nodes which link to or from some node in a Document. |
AttributeValue |
getNodeAttribute(NodeAddress nodeAddress,
AttributeID attribute,
boolean overrideInheritance)
Retrieve a node's attribute's value. |
NodeProxy |
getNodeProxy(NodeAddress address)
|
NodeRepositoryID |
getRepositoryID(NodeRepository repository)
|
boolean |
nodeAttributeEquals(NodeAddress nodeAddress,
AttributeID attribute,
AttributeValue other,
boolean overrideInheritance)
Determine whether a node's attribute is equal to some constant value. |
boolean |
nodeAttributeGreaterThan(NodeAddress nodeAddress,
AttributeID attribute,
AttributeValue other,
boolean overrideInheritance)
Determine whether a node's attribute is greater than some constant value. |
CommandReturn |
unlink(NodeAddress fromAddress,
LinkType linkType,
NodeAddress toAddress)
Remove all direct links of a certain type between two nodes in the Document. |
SatisfactionResult |
validateNodeInstancing(NodeInstancing instancing)
Determine the validity of a NodeInstancing. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public DocumentID getID()
public NodeRepositoryID getRepositoryID(NodeRepository repository) throws Scheherexception
Scheherexception
public NodeProxy getNodeProxy(NodeAddress address) throws Scheherexception
Scheherexception
public CommandReturn unlink(NodeAddress fromAddress, LinkType linkType, NodeAddress toAddress) throws Scheherexception
from
- The node on the left side of the link.linkType
- The type of link to remove.to
- The node on the right side of the link.
NoSuchLinks
- If there are no such links.
Scheherexception
- If some other error occurs.public RelatedNodes getLinksOfNode(NodeAddress nodeAddress, LinkType linkType, LinkDirection direction) throws Scheherexception
to
- The node on the right side of the relationlinkType
- The type of link the nodes will be related asdirection
- The appropriate LinkDirection:
From will return nodes that occur on the right side of
the link from the given node; To for nodes on the left
side.
Scheherexception
public NodeAddress findNodeAddress(NodeID nodeID) throws Scheherexception
Scheherexception
public AttributeValue getNodeAttribute(NodeAddress nodeAddress, AttributeID attribute, boolean overrideInheritance) throws Scheherexception
Scheherexception
public boolean nodeAttributeEquals(NodeAddress nodeAddress, AttributeID attribute, AttributeValue other, boolean overrideInheritance) throws Scheherexception
Scheherexception
public boolean nodeAttributeGreaterThan(NodeAddress nodeAddress, AttributeID attribute, AttributeValue other, boolean overrideInheritance) throws Scheherexception
Scheherexception
public SatisfactionResult validateNodeInstancing(NodeInstancing instancing) throws Scheherexception
Scheherexception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |