@sitevision/api 1.0.20 → 1.1.0-alpha.1

package/hidden/javax/jcr/query/qom/FullTextSearch/index.d.ts

@@ -0,0 +1,89 @@
+import StaticOperand from "../StaticOperand";
+
+/**
+ * Performs a full-text search.
+ * <p>
+ * The full-text search expression is evaluated against the set of full-text
+ * indexed properties within the full-text search scope.  If {@link
+ * #getPropertyName property} is specified, the full-text search scope is the
+ * property of that name on the {@link #getSelectorName selector} node in the
+ * node-tuple; otherwise the full-text search scope is all properties of the
+ * {@link #getSelectorName selector} node (or, in some implementations, all
+ * properties in the node subgraph).
+ * <p>
+ * Which properties (if any) in a repository are full-text indexed is
+ * implementation determined.
+ * <p>
+ * It is also implementation determined whether {@link #getFullTextSearchExpression
+ * fullTextSearchExpression} is independently evaluated against each full-text
+ * indexed property in the full-text search scope, or collectively evaluated
+ * against the set of such properties using some implementation-determined
+ * mechanism.
+ * <p>
+ * Similarly, for multi-valued properties, it is implementation determined
+ * whether {@link #getFullTextSearchExpression fullTextSearchExpression} is
+ * independently evaluated against each element in the array of values, or
+ * collectively evaluated against the array of values using some
+ * implementation-determined mechanism.
+ * <p>
+ * At minimum, an implementation must support the following {@link
+ * #getFullTextSearchExpression fullTextSearchExpression} grammar:
+ * </p>
+ * <pre>
+ *    fullTextSearchExpression ::= [-]term {whitespace [OR] whitespace [-]term}
+ *    term ::= word | '"' word {whitespace word} '"'
+ *    word ::= (A string containing no whitespace)
+ *    whitespace ::= (A string of only whitespace)
+ * </pre>
+ * <p>
+ * A query satisfies a <code>FullTextSearch</code> constraint if the value (or
+ * values) of the full-text indexed properties within the full-text search scope
+ * satisfy the specified {@link #getFullTextSearchExpression
+ * fullTextSearchExpression}, evaluated as follows:
+ * </p>
+ * <ul>
+ *    <li>
+ *       A term not preceded with "<code>-</code>" (minus sign) is satisfied only if the value contains that term.
+ *    </li>
+ *    <li>
+ *       A term preceded with "<code>-</code>" (minus sign) is satisfied only if the value does not contain that term.
+ *    </li>
+ *    <li>
+ *       Terms separated by whitespace are implicitly "ANDed".
+ *    </li>
+ *    <li>
+ *       Terms separated by "<code>OR</code>" are "ORed".
+ *    </li>
+ *    <li>
+ *       "AND" has higher precedence than "OR".
+ *    </li>
+ *    <li>
+ *       Within a term, each double quote (<code>"</code>), "<code>-</code>" (minus sign), and "<code>\</code>" (backslash)
+ *       must be escaped by a preceding "<code>\</code>" (backslash).
+ *    </li>
+ * </ul>
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>Gets the name of the selector against which to apply this constraint.Gets the name of the property.Gets the full-text search expression.
+ * @since JCR 2.0
+ */
+interface FullTextSearch {
+  /**
+   * Gets the name of the selector against which to apply this constraint.
+   * @return the selector name; non-null
+   */
+  getSelectorName(): string;
+
+  /**
+   * Gets the name of the property.
+   * @return the property name if the full-text search scope is a property, otherwise null if the full-text search scope is the node (or node subgraph, in some implementations).
+   */
+  getPropertyName(): string;
+
+  /**
+   * Gets the full-text search expression.
+   * @return the full-text search expression; non-null
+   */
+  getFullTextSearchExpression(): StaticOperand;
+}
+
+export default FullTextSearch;

package/hidden/javax/jcr/query/qom/FullTextSearchScore/index.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Evaluates to a <code>DOUBLE</code> value equal to the full-text search score
+ * of a node.
+ * <p>
+ * Full-text search score ranks a selector's nodes by their relevance to the
+ * <code>fullTextSearchExpression</code> specified in a {@link FullTextSearch}.
+ * The values to which <code>FullTextSearchScore</code> evaluates and the
+ * interpretation of those values are implementation specific.
+ * <code>FullTextSearchScore</code> may evaluate to a constant value in a
+ * repository that does not support full-text search scoring or has no full-text
+ * indexed properties.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>Gets the name of the selector against which to evaluate this operand.
+ * @since JCR 2.0
+ */
+interface FullTextSearchScore {
+  /**
+   * Gets the name of the selector against which to evaluate this operand.
+   * @return the selector name; non-null
+   */
+  getSelectorName(): string;
+}
+
+export default FullTextSearchScore;

package/hidden/javax/jcr/query/qom/Join/index.d.ts

@@ -0,0 +1,36 @@
+import Source from "../Source";
+import JoinCondition from "../JoinCondition";
+
+/**
+ * Performs a join between two node-tuple sources.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>Gets the left node-tuple source.Gets the right node-tuple source.Gets the join type.Gets the join condition.
+ * @since JCR 2.0
+ */
+interface Join {
+  /**
+   * Gets the left node-tuple source.
+   * @return the left source; non-null
+   */
+  getLeft(): Source;
+
+  /**
+   * Gets the right node-tuple source.
+   * @return the right source; non-null
+   */
+  getRight(): Source;
+
+  /**
+   * Gets the join type.
+   * @return either <ul> <li>{@link QueryObjectModelConstants#JCR_JOIN_TYPE_INNER},</li> <li>{@link QueryObjectModelConstants#JCR_JOIN_TYPE_LEFT_OUTER},</li> <li>{@link QueryObjectModelConstants#JCR_JOIN_TYPE_RIGHT_OUTER}</li> </ul>
+   */
+  getJoinType(): string;
+
+  /**
+   * Gets the join condition.
+   * @return the join condition; non-null
+   */
+  getJoinCondition(): JoinCondition;
+}
+
+export default Join;

package/hidden/javax/jcr/query/qom/JoinCondition/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Filters the set of node-tuples formed from a {@link Join join}.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>
+ * @since JCR 2.0
+ */
+interface JoinCondition {}
+
+export default JoinCondition;

package/hidden/javax/jcr/query/qom/Length/index.d.ts

@@ -0,0 +1,24 @@
+import PropertyValue from "../PropertyValue";
+
+/**
+ * Evaluates to the length (or lengths, if multi-valued) of a property.
+ * <p>
+ * The length should be computed as though the <code>getLength</code> method (or
+ * <code>getLengths</code>, if multi-valued) of <code>javax.jcr.Property</code>
+ * were called.
+ * <p>
+ * If {@link #getPropertyValue propertyValue} evaluates to null, the
+ * <code>Length</code> operand also evaluates to null.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>Gets the property value for which to compute the length.
+ * @since JCR 2.0
+ */
+interface Length {
+  /**
+   * Gets the property value for which to compute the length.
+   * @return the property value; non-null
+   */
+  getPropertyValue(): PropertyValue;
+}
+
+export default Length;

package/hidden/javax/jcr/query/qom/Literal/index.d.ts

@@ -0,0 +1,18 @@
+import Value from "../../../Value";
+
+/**
+ * Evaluates to a literal value.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>Gets the value of the literal.
+ * @since Sitevision 3.5
+ * @since JCR 2.0
+ */
+interface Literal {
+  /**
+   * Gets the value of the literal.
+   * @return the value of the literal.
+   */
+  getLiteralValue(): Value;
+}
+
+export default Literal;

package/hidden/javax/jcr/query/qom/LowerCase/index.d.ts

@@ -0,0 +1,26 @@
+import DynamicOperand from "../DynamicOperand";
+
+/**
+ * Evaluates to the lower-case string value (or values, if multi-valued) of
+ * {@link #getOperand operand}.
+ * <p>
+ * If {@link #getOperand operand} does not evaluate to a string value, its value
+ * is first converted to a string.  The lower-case string value is computed as
+ * though the <code>toLowerCase()</code> method of <code>java.lang.String</code>
+ * were called.
+ * <p>
+ * If {@link #getOperand operand} evaluates to null, the <code>LowerCase</code>
+ * operand also evaluates to null.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>Gets the operand whose value is converted to a lower-case string.
+ * @since JCR 2.0
+ */
+interface LowerCase {
+  /**
+   * Gets the operand whose value is converted to a lower-case string.
+   * @return the operand; non-null
+   */
+  getOperand(): DynamicOperand;
+}
+
+export default LowerCase;

package/hidden/javax/jcr/query/qom/NodeLocalName/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Evaluates to a <code>NAME</code> value equal to the local (unprefixed) name
+ * of a node.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>Gets the name of the selector against which to evaluate this operand.
+ * @since JCR 2.0
+ */
+interface NodeLocalName {
+  /**
+   * Gets the name of the selector against which to evaluate this operand.
+   * @return the selector name; non-null
+   */
+  getSelectorName(): string;
+}
+
+export default NodeLocalName;

package/hidden/javax/jcr/query/qom/NodeName/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Evaluates to a <code>NAME</code> value equal to the namespace-qualified name
+ * of a node.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>Gets the name of the selector against which to evaluate this operand.
+ * @since JCR 2.0
+ */
+interface NodeName {
+  /**
+   * Gets the name of the selector against which to evaluate this operand.
+   * @return the selector name; non-null
+   */
+  getSelectorName(): string;
+}
+
+export default NodeName;

package/hidden/javax/jcr/query/qom/Not/index.d.ts

@@ -0,0 +1,20 @@
+import Constraint from "../Constraint";
+
+/**
+ * Performs a logical negation of another constraint.
+ * <p>
+ * To satisfy the <code>Not</code> constraint, the node-tuple must <i>not</i>
+ * satisfy {@link #getConstraint constraint}.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>Gets the constraint negated by this <code>Not</code> constraint.
+ * @since JCR 2.0
+ */
+interface Not {
+  /**
+   * Gets the constraint negated by this <code>Not</code> constraint.
+   * @return the constraint; non-null
+   */
+  getConstraint(): Constraint;
+}
+
+export default Not;

package/hidden/javax/jcr/query/qom/Operand/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * An operand to a binary operation specified by a {@link Comparison}.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>
+ * @since JCR 2.0
+ */
+interface Operand {}
+
+export default Operand;

package/hidden/javax/jcr/query/qom/Or/index.d.ts

@@ -0,0 +1,30 @@
+import Constraint from "../Constraint";
+
+/**
+ * Performs a logical disjunction of two other constraints.
+ * <p>
+ * To satisfy the <code>Or</code> constraint, the node-tuple must either: <ul>
+ * <li>satisfy {@link #getConstraint1 constraint1} but not {@link
+ * #getConstraint2 constraint2}, or</li> <li>satisfy {@link #getConstraint2
+ * constraint2} but not {@link #getConstraint1 constraint1}, or</li> <li>satisfy
+ * both {@link #getConstraint1 constraint1} and {@link #getConstraint2
+ * constraint2}.</li> </ul>
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>Gets the first constraint.Gets the second constraint.
+ * @since JCR 2.0
+ */
+interface Or {
+  /**
+   * Gets the first constraint.
+   * @return the constraint; non-null
+   */
+  getConstraint1(): Constraint;
+
+  /**
+   * Gets the second constraint.
+   * @return the constraint; non-null
+   */
+  getConstraint2(): Constraint;
+}
+
+export default Or;

package/hidden/javax/jcr/query/qom/Ordering/index.d.ts

@@ -0,0 +1,53 @@
+import DynamicOperand from "../DynamicOperand";
+
+/**
+ * Determines the relative order of two node-tuples by evaluating {@link
+ * #getOperand operand} for each.
+ * <p>
+ * For a first node-tuple, <code>nt1</code>, for which {@link #getOperand
+ * operand} evaluates to <code>v1</code>, and a second node-tuple,
+ * <code>nt2</code>, for which {@link #getOperand operand} evaluates to
+ * <code>v2</code>: <ul> <li>If {@link #getOrder order} is
+ * <code>Ascending</code>, then:<ul> <li>if either <code>v1</code> is null,
+ * <code>v2</code> is null, or both <code>v1</code> and <code>v2</code> are
+ * null, the relative order of <code>nt1</code> and <code>nt2</code> is
+ * implementation determined, otherwise</li> <li>if <code>v1</code> is a
+ * different property type than <code>v2</code>, the relative order of
+ * <code>nt1</code> and <code>nt2</code> is implementation determined,
+ * otherwise</li> <li>if <code>v1</code> is ordered before <code>v2</code>, then
+ * <code>nt1</code> precedes <code>nt2</code>, otherwise</li> <li>if
+ * <code>v1</code> is ordered after <code>v2</code>, then <code>nt2</code>
+ * precedes <code>nt1</code>, otherwise</li> <li>the relative order of
+ * <code>nt1</code> and <code>nt2</code> is implementation determined and may be
+ * arbitrary.</li></ul></li> <li>Otherwise, if {@link #getOrder order} is
+ * <code>Descending</code>, then:<ul> <li>if either <code>v1</code> is null,
+ * <code>v2</code> is null, or both <code>v1</code> and <code>v2</code> are
+ * null, the relative order of <code>nt1</code> and <code>nt2</code> is
+ * implementation determined, otherwise</li> <li>if <code>v1</code> is a
+ * different property type than <code>v2</code>, the relative order of
+ * <code>nt1</code> and <code>nt2</code> is implementation determined,
+ * otherwise</li> <li>if <code>v1</code> is ordered before <code>v2</code>, then
+ * <code>nt2</code> precedes <code>nt1</code>, otherwise</li> <li>if
+ * <code>v1</code> is ordered after <code>v2</code>, then <code>nt1</code>
+ * precedes <code>nt2</code>, otherwise</li> <li>the relative order of
+ * <code>nt1</code> and <code>nt2</code> is implementation determined and may be
+ * arbitrary.</li></ul></li> </ul>
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>The operand by which to order.Gets the order.
+ * @since JCR 2.0
+ */
+interface Ordering {
+  /**
+   * The operand by which to order.
+   * @return the operand; non-null
+   */
+  getOperand(): DynamicOperand;
+
+  /**
+   * Gets the order.
+   * @return either <ul> <li>{@link QueryObjectModelConstants#JCR_ORDER_ASCENDING} or</li> <li>{@link QueryObjectModelConstants#JCR_ORDER_DESCENDING}</li> </ul>
+   */
+  getOrder(): string;
+}
+
+export default Ordering;

package/hidden/javax/jcr/query/qom/PropertyExistence/index.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Tests the existence of a property.
+ * <p>
+ * A node-tuple satisfies the constraint if the selector node has a property
+ * named {@link #getPropertyName property}.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>Gets the name of the selector against which to apply this constraint.Gets the name of the property.
+ * @since JCR 2.0
+ */
+interface PropertyExistence {
+  /**
+   * Gets the name of the selector against which to apply this constraint.
+   * @return the selector name; non-null
+   */
+  getSelectorName(): string;
+
+  /**
+   * Gets the name of the property.
+   * @return the property name; non-null
+   */
+  getPropertyName(): string;
+}
+
+export default PropertyExistence;

package/hidden/javax/jcr/query/qom/PropertyValue/index.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Evaluates to the value (or values, if multi-valued) of a property.
+ * <p>
+ * If, for a node-tuple, the {@link #getSelectorName selector} node does not
+ * have a property named {@link #getPropertyName property}, the operand
+ * evaluates to null.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>Gets the name of the selector against which to evaluate this operand.Gets the name of the property.
+ * @since JCR 2.0
+ */
+interface PropertyValue {
+  /**
+   * Gets the name of the selector against which to evaluate this operand.
+   * @return the selector name; non-null
+   */
+  getSelectorName(): string;
+
+  /**
+   * Gets the name of the property.
+   * @return the property name; non-null
+   */
+  getPropertyName(): string;
+}
+
+export default PropertyValue;

package/hidden/javax/jcr/query/qom/QueryObjectModel/index.d.ts

@@ -0,0 +1,64 @@
+import Source from "../Source";
+import Constraint from "../Constraint";
+import Ordering from "../Ordering";
+import Column from "../Column";
+
+/**
+ * A query in the JCR query object model.
+ * <p>
+ * The JCR query object model describes the queries that can be evaluated by a
+ * JCR repository independent of any particular query language, such as SQL.
+ * <p>
+ * A query consists of: <ul> <li>a source.  When the query is evaluated, the
+ * source evaluates its selectors and the joins between them to produce a
+ * (possibly empty) set of node-tuples.  This is a set of 1-tuples if the query
+ * has one selector (and therefore no joins), a set of 2-tuples if the query has
+ * two selectors (and therefore one join), a set of 3-tuples if the query has
+ * three selectors (two joins), and so forth.</li> <li>an optional constraint.
+ * When the query is evaluated, the constraint filters the set of
+ * node-tuples.</li> <li>a list of zero or more orderings.  The orderings
+ * specify the order in which the node-tuples appear in the query results.  The
+ * relative order of two node-tuples is determined by evaluating the specified
+ * orderings, in list order, until encountering an ordering for which one
+ * node-tuple precedes the other.  If no orderings are specified, or if for none
+ * of the specified orderings does one node-tuple precede the other, then the
+ * relative order of the node-tuples is implementation determined (and may be
+ * arbitrary).</li> <li>a list of zero or more columns to include in the tabular
+ * view of the query results.  If no columns are specified, the columns
+ * available in the tabular view are implementation determined, but minimally
+ * include, for each selector, a column for each single-valued non-residual
+ * property of the selector's node type.</li> </ul>
+ * <p>
+ * The query object model representation of a query is created by factory
+ * methods in the {@link QueryObjectModelFactory}.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>Gets the node-tuple source for this query.Gets the constraint for this query.Gets the orderings for this query.Gets the columns for this query.
+ * @since JCR 2.0
+ */
+interface QueryObjectModel {
+  /**
+   * Gets the node-tuple source for this query.
+   * @return the node-tuple source; non-null
+   */
+  getSource(): Source;
+
+  /**
+   * Gets the constraint for this query.
+   * @return the constraint, or null if none
+   */
+  getConstraint(): Constraint;
+
+  /**
+   * Gets the orderings for this query.
+   * @return an array of zero or more orderings; non-null
+   */
+  getOrderings(): Ordering;
+
+  /**
+   * Gets the columns for this query.
+   * @return an array of zero or more columns; non-null
+   */
+  getColumns(): Column;
+}
+
+export default QueryObjectModel;

package/hidden/javax/jcr/query/qom/QueryObjectModelConstants/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Defines constants used in the query object model.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>An inner join.A left-outer join.A right-outer join.The "<code>=</code>" comparison operator.The "<code>!=</code>" comparison operator.The "<code>&lt;</code>" comparison operator.The "<code>&lt;=</code>" comparison operator.The "<code>&gt;</code>" comparison operator.The "<code>&gt;=</code>" comparison operator.The "<code>like</code>" comparison operator.Ascending order.Descending order.
+ * @since JCR 2.0
+ */
+interface QueryObjectModelConstants {}
+
+export default QueryObjectModelConstants;