com.aspc.file

Class VirtualDBNode

java.lang.Object

com.aspc.file.VirtualDBNode

public class VirtualDBNode
extends java.lang.Object

Since:

21 Oct 2013

Author:

Liam Itzhaki

Constructor Summary

Constructors

Constructor and Description
VirtualDBNode(MutableDataSource mds, java.lang.String name, DBNode parent)
VirtualDBNode(MutableDataSource mds, java.lang.String name, java.lang.String displayName, DBNode parent)

Method Summary

Modifier and Type	Method and Description
double	getFullTextSearchScore(java.lang.String... args) Evaluates to a DOUBLE value equal to the full-text search score of a node.
DBNode	getParent()
java.lang.String	getPrimaryType(java.lang.String... args) The primary type.
java.util.List	getProperties(java.lang.String... args) The list of properties.
java.util.List	getReferencesUUID(java.lang.String... args) The UUIDs of all nodes that point to this node.
int	getSequence(java.lang.String... args) The sequence of this node.
java.lang.String	getUUID(java.lang.String... args) If a node is referenceable, the Identifier of the Node must be the value of its jcr:UUID property.
java.util.List	getWeakReferencesUUID(java.lang.String... args) The UUIDs of all nodes that point to this node.
boolean	isChildNode(java.lang.String... args) Tests whether the selectorName node is a child of a node reachable by the absolute path specified.
boolean	isContains(java.lang.String... args) A query satisfies a FullTextSearch constraint if the value (or values) of the full-text indexed properties within the full-text search scope satisfy the specified fullTextSearchExpression, evaluated as follows: A term not preceded with '-' (minus sign) is satisfied only if the value contains that term.
boolean	isDescendantNode(java.lang.String... args) Tests whether the selectorName node is a descendant of a node reachable by the absolute path specified.
boolean	isDirectory()
boolean	isPublic(java.lang.String... args)
boolean	isReferenceable(java.lang.String... args) In implementations that support referenceable nodes, these nodes have more stringent requirements on their identifiers (see §3.8 Referenceable Nodes).
boolean	isSameNode(java.lang.String... args) Tests whether the selectorName node is reachable by the absolute path specified.
boolean	isVersionable(java.lang.String... args) Is this node versionable.
long	lastModified()
DBNode[]	listNodes()
DBNode	setPrimaryType(java.lang.String value, java.lang.String... args) The primary type.
DBNode	setProperties(java.util.List value, java.lang.String... args) The list of properties.
DBNode	setReferenceable(boolean value, java.lang.String... args) In implementations that support referenceable nodes, these nodes have more stringent requirements on their identifiers (see §3.8 Referenceable Nodes).
DBNode	setReferencesUUID(java.util.List value, java.lang.String... args) The UUIDs of all nodes that point to this node.
DBNode	setSequence(int value, java.lang.String... args) The sequence of this node.
DBNode	setUUID(java.lang.String value, java.lang.String... args) If a node is referenceable, the Identifier of the Node must be the value of its jcr:UUID property.
DBNode	setVersionable(boolean value, java.lang.String... args) Is this node versionable.
DBNode	setWeakReferencesUUID(java.util.List value, java.lang.String... args) The UUIDs of all nodes that point to this node.
java.lang.String	vDisplayName()
java.lang.String	vName()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VirtualDBNode

public VirtualDBNode(MutableDataSource mds,
                     java.lang.String name,
                     DBNode parent)

VirtualDBNode

public VirtualDBNode(MutableDataSource mds,
                     java.lang.String name,
                     java.lang.String displayName,
                     DBNode parent)

Method Detail

getParent

public DBNode getParent()

listNodes

public DBNode[] listNodes()
                   throws java.lang.Exception

Throws:

java.lang.Exception

lastModified

public long lastModified()

isDirectory

public boolean isDirectory()

vName

public java.lang.String vName()

vDisplayName

public java.lang.String vDisplayName()

getUUID

public java.lang.String getUUID(java.lang.String... args)

If a node is referenceable, the Identifier of the Node must be the value of its jcr:UUID property. If the node is not referenceable, the Identifier of the node should be as stable as the repository can make it. For example, if there is no property of the node that could be effectively used as an identifier, a reasonable Identifier would be the combination of the jcr:UUID of the nearest referenceable parent combined with the relative path of that node wrt that nearest referenceable parent.

(String, Searchable)

Parameters:

args - the optional arguments

Returns:

UUID

setUUID

@Nonnull
public DBNode setUUID(java.lang.String value,
                               java.lang.String... args)
                        throws java.lang.Exception

If a node is referenceable, the Identifier of the Node must be the value of its jcr:UUID property. If the node is not referenceable, the Identifier of the node should be as stable as the repository can make it. For example, if there is no property of the node that could be effectively used as an identifier, a reasonable Identifier would be the combination of the jcr:UUID of the nearest referenceable parent combined with the relative path of that node wrt that nearest referenceable parent.

(String, Searchable)

Parameters:

value - UUID

args - the optional arguments

Throws:

java.lang.Exception - a serious problem.

isContains

public boolean isContains(java.lang.String... args)

A query satisfies a FullTextSearch constraint if the value (or values) of the full-text indexed properties within the full-text search scope satisfy the specified fullTextSearchExpression, evaluated as follows:

A term not preceded with '-' (minus sign) is satisfied only if the value contains that term.

A term preceded with '-' (minus sign) is satisfied only if the value does not contain that term.

Terms separated by whitespace are implicitly 'ANDed'.

Terms separated by 'OR' are 'ORed'.

'AND' has higher precedence than 'OR'.

Within a term, each '"' (double quote), '-' (minus sign), and '\' (backslash) must be escaped by a preceding '\'.

(Boolean, Derived)

Parameters:

args - the optional arguments

Returns:

Contains

getFullTextSearchScore

public double getFullTextSearchScore(java.lang.String... args)

Evaluates to a DOUBLE value equal to the full-text search score of a node.

Full-text search score ranks a selector's nodes by their relevance to the fullTextSearchExpression specified in a FullTextSearch. The values to which FullTextSearchScore evaluates and the interpretation of those values are implementation specific. FullTextSearchScore may evaluate to a constant value in a repository that does not support full-text search scoring or has no full-text indexed properties.

The query is invalid if selector is not the name of a selector in the query.

(Float, Derived)

Parameters:

args - the optional arguments

Returns:

Full Text Search Score

isChildNode

public boolean isChildNode(java.lang.String... args)

Tests whether the selectorName node is a child of a node reachable by the absolute path specified. A node-tuple satisfies the constraint only if:

selectorNode.getParent().isSame(session.getNode(path))

would return true, where selectorNode is the node for the specified selector.

The query is invalid if:

selectorName is not the name of a selector in the query, or

path is not a syntactically valid absolute path (see §3.3.4 Lexical Path Grammar). Note, however, that if path is syntactically valid but does not identify a node in the workspace (or the node is not visible to this session, because of access control constraints), the query is valid but the constraint is not satisfied.

(Boolean, Derived)

Parameters:

args - the optional arguments

Returns:

Is Child Node

isDescendantNode

public boolean isDescendantNode(java.lang.String... args)

Tests whether the selectorName node is a descendant of a node reachable by the absolute path specified. A node-tuple satisfies the constraint only if:

selectorNode.getAncestor(n).isSame(session.getNode(path))
&& selectorNode.getDepth() > n

would return true for some non-negative integer n, where selectorNode is the node for the specified selector.

The query is invalid if:

selectorName is not the name of a selector in the query, or

path is not a syntactically valid absolute path (see §3.3.4 Lexical Path Grammar). Note, however, that if path is syntactically valid but does not identify a node in the workspace (or the node is not visible to this session, because of access control constraints), the query is valid but the constraint is not satisfied.

(Boolean, Derived)
Notes

http://www.day.com/specs/jcr/2.0/6_Query.html

Parameters:

args - the optional arguments

Returns:

Is Descendant Node

isSameNode

public boolean isSameNode(java.lang.String... args)

Tests whether the selectorName node is reachable by the absolute path specified. A node-tuple satisfies the constraint only if:

selectorNode.isSame(session.getNode(path))

would return true, where selectorNode is the node for the specified selector.

The query is invalid if:

selectorName is not the name of a selector in the query, or

path is not a syntactically valid absolute path (see §3.3.4 Lexical Path Grammar). Note, however, that if path is syntactically valid but does not identify a node in the workspace (or the node is not visible to this session, because of access control constraints), the query is valid but the constraint is not satisfied.

(Boolean, Derived)

Parameters:

args - the optional arguments

Returns:

Is Same Node

getPrimaryType

public java.lang.String getPrimaryType(java.lang.String... args)

The primary type.

(String)

Parameters:

args - the optional arguments

Returns:

Primary Type

setPrimaryType

@Nonnull
public DBNode setPrimaryType(java.lang.String value,
                                      java.lang.String... args)
                               throws java.lang.Exception

The primary type.

(String)

Parameters:

value - Primary Type

args - the optional arguments

Throws:

java.lang.Exception - a serious problem.

getProperties

public java.util.List getProperties(java.lang.String... args)

The list of properties.

(custom: com.aspc.DBObj.Misc.PropertyValueFactory)

Parameters:

args - the optional arguments

Returns:

Properties

setProperties

@Nonnull
public DBNode setProperties(java.util.List value,
                                     java.lang.String... args)
                              throws java.lang.Exception

The list of properties.

(custom: com.aspc.DBObj.Misc.PropertyValueFactory)

Parameters:

value - Properties

args - the optional arguments

Throws:

java.lang.Exception - a serious problem.

isReferenceable

public boolean isReferenceable(java.lang.String... args)

In implementations that support referenceable nodes, these nodes have more stringent requirements on their identifiers (see §3.8 Referenceable Nodes).

"mix:referenceable"

http://www.day.com/specs/jcr/2.0/3_Repository_Model.html#3.3.2 %20Referenceable%20Identifiers

(Boolean)
Notes

3.8 Referenceable Nodes

A repository may support referenceable nodes. A node must be referenceable to serve as the target of a reference property, which is either a WEAKREFERENCE or REFERENCE. To be referenceable a node must be of type mix:referenceable.

3.8.1.1 mix:referenceable

[mix:referenceable]

mixin

- jcr:uuid (STRING) mandatory autocreated protected

INITIALIZE

This node type adds an auto-created, mandatory, protected STRING property to the node, called jcr:uuid, which exposes the identifier of the node. Note that the term “UUID” is used for backward compatibility with JCR 1.0 and does not necessarily imply the use of the UUID syntax, or global uniqueness.

The identifier of a referenceable node must be a referenceable identifier. Referenceable identifiers must fulfill a number of constraints beyond the minimum required of standard identifiers (see §3.8.3 Referenceable Identifiers).

A reference property is a property that holds the referenceable identifier of a referenceable node and therefore serves as a pointer to that node. The two types of reference properties, REFERENCE and WEAKREFERENCE differ in that the former enforces referential integrity while the latter does not (see §3.8.2 Referential Integrity). A repository may support only WEAKREFERENCE or both WEAKREFERENCE and REFERENCE property types.

3.8.2 Referential Integrity

Given a property P with value V in workspace W:

If P is of type REFERENCE then there must exist a node in W with identifier V.

If P is of type WEAKREFERENCE, no such restriction exists.

In a read-only context the only difference between the types is that a workspace cannot contain a dangling REFERENCE while it may contain a dangling WEAKREFERENCE.

3.8.2.1 Exceptions to Referential Integrity

In a repository that exposes version storage in content, such as one that supports full versioning, an exception is made to the referential integrity rule when the REFERENCE property in question is part of the frozen state of a version stored in version storage. In that case the frozen REFERENCE property may hold the identifier of a node that is no longer in the workspace (see §3.13.3.7 References in a Frozen Node).

3.8.3 Referenceable Identifiers

Every node has an identifier, where an identifier is a string which is the most stable available. A referenceable node, however, must have a referenceable identifier, which is subject to a number of further constraints:

3.8.3.1 Identifier Assignment

As with any identifier, a referenceable node's identifier must be assigned at the latest when the node is first persisted. However, the jcr:uuid property of the node must be created immediately upon the node becoming referenceable, which may be upon node creation or upon a later mixin addition. Consequently, the value of the jcr:uuid property before the first persist is not guaranteed to be the identifier of the node.

3.8.3.2 Identifier Immutable across Move and Clone

The identifier is immutable during the lifetime of the node, that is, until the node is deleted though a remove operation. In particular, the identifier is immutable across move and clone operations. Note that non-referenceable identifiers are not required to be immutable across these operations. As in the non-referenceable case, the referenceable identifier is not immutable across copy operations. This operation results in the creation of a new node with a new identifier.

3.8.3.3 Implementation Variations

These are the minimum requirements for a referenceable identifier, but implementations are free to exceed these requirements.

Parameters:

args - the optional arguments

Returns:

Referenceable

setReferenceable

@Nonnull
public DBNode setReferenceable(boolean value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

In implementations that support referenceable nodes, these nodes have more stringent requirements on their identifiers (see §3.8 Referenceable Nodes).

"mix:referenceable"

http://www.day.com/specs/jcr/2.0/3_Repository_Model.html#3.3.2 %20Referenceable%20Identifiers

(Boolean)
Notes

3.8 Referenceable Nodes

A repository may support referenceable nodes. A node must be referenceable to serve as the target of a reference property, which is either a WEAKREFERENCE or REFERENCE. To be referenceable a node must be of type mix:referenceable.

3.8.1.1 mix:referenceable

[mix:referenceable]

mixin

- jcr:uuid (STRING) mandatory autocreated protected

INITIALIZE

This node type adds an auto-created, mandatory, protected STRING property to the node, called jcr:uuid, which exposes the identifier of the node. Note that the term “UUID” is used for backward compatibility with JCR 1.0 and does not necessarily imply the use of the UUID syntax, or global uniqueness.

The identifier of a referenceable node must be a referenceable identifier. Referenceable identifiers must fulfill a number of constraints beyond the minimum required of standard identifiers (see §3.8.3 Referenceable Identifiers).

A reference property is a property that holds the referenceable identifier of a referenceable node and therefore serves as a pointer to that node. The two types of reference properties, REFERENCE and WEAKREFERENCE differ in that the former enforces referential integrity while the latter does not (see §3.8.2 Referential Integrity). A repository may support only WEAKREFERENCE or both WEAKREFERENCE and REFERENCE property types.

3.8.2 Referential Integrity

Given a property P with value V in workspace W:

If P is of type REFERENCE then there must exist a node in W with identifier V.

If P is of type WEAKREFERENCE, no such restriction exists.

In a read-only context the only difference between the types is that a workspace cannot contain a dangling REFERENCE while it may contain a dangling WEAKREFERENCE.

3.8.2.1 Exceptions to Referential Integrity

In a repository that exposes version storage in content, such as one that supports full versioning, an exception is made to the referential integrity rule when the REFERENCE property in question is part of the frozen state of a version stored in version storage. In that case the frozen REFERENCE property may hold the identifier of a node that is no longer in the workspace (see §3.13.3.7 References in a Frozen Node).

3.8.3 Referenceable Identifiers

Every node has an identifier, where an identifier is a string which is the most stable available. A referenceable node, however, must have a referenceable identifier, which is subject to a number of further constraints:

3.8.3.1 Identifier Assignment

As with any identifier, a referenceable node's identifier must be assigned at the latest when the node is first persisted. However, the jcr:uuid property of the node must be created immediately upon the node becoming referenceable, which may be upon node creation or upon a later mixin addition. Consequently, the value of the jcr:uuid property before the first persist is not guaranteed to be the identifier of the node.

3.8.3.2 Identifier Immutable across Move and Clone

The identifier is immutable during the lifetime of the node, that is, until the node is deleted though a remove operation. In particular, the identifier is immutable across move and clone operations. Note that non-referenceable identifiers are not required to be immutable across these operations. As in the non-referenceable case, the referenceable identifier is not immutable across copy operations. This operation results in the creation of a new node with a new identifier.

3.8.3.3 Implementation Variations

These are the minimum requirements for a referenceable identifier, but implementations are free to exceed these requirements.

Parameters:

value - Referenceable

args - the optional arguments

Throws:

java.lang.Exception - a serious problem.

getReferencesUUID

public java.util.List getReferencesUUID(java.lang.String... args)

The UUIDs of all nodes that point to this node.

(String)

Parameters:

args - the optional arguments

Returns:

References UUID

setReferencesUUID

@Nonnull
public DBNode setReferencesUUID(java.util.List value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

The UUIDs of all nodes that point to this node.

(String)

Parameters:

value - References UUID

args - the optional arguments

Throws:

java.lang.Exception - a serious problem.

getSequence

public int getSequence(java.lang.String... args)

The sequence of this node.

(Integer)

Parameters:

args - the optional arguments

Returns:

Sequence

setSequence

@Nonnull
public DBNode setSequence(int value,
                                   java.lang.String... args)
                            throws java.lang.Exception

The sequence of this node.

(Integer)

Parameters:

value - Sequence

args - the optional arguments

Throws:

java.lang.Exception - a serious problem.

isVersionable

public boolean isVersionable(java.lang.String... args)

Is this node versionable.

(Boolean)

Parameters:

args - the optional arguments

Returns:

Versionable

setVersionable

@Nonnull
public DBNode setVersionable(boolean value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Is this node versionable.

(Boolean)

Parameters:

value - Versionable

args - the optional arguments

Throws:

java.lang.Exception - a serious problem.

getWeakReferencesUUID

public java.util.List getWeakReferencesUUID(java.lang.String... args)

The UUIDs of all nodes that point to this node.

(String)

Parameters:

args - the optional arguments

Returns:

Weak References UUID

setWeakReferencesUUID

@Nonnull
public DBNode setWeakReferencesUUID(java.util.List value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

The UUIDs of all nodes that point to this node.

(String)

Parameters:

value - Weak References UUID

args - the optional arguments

Throws:

java.lang.Exception - a serious problem.

isPublic

public boolean isPublic(java.lang.String... args)