public interface CtsExpr
| Modifier and Type | Method | Description |
|---|---|---|
CtsQueryExpr |
afterQuery(ServerExpression timestamp) |
Returns a query matching fragments committed
after a specified timestamp.
|
CtsQueryExpr |
andNotQuery(ServerExpression positiveQuery,
ServerExpression negativeQuery) |
Returns a query specifying the set difference of
the matches specified by two sub-queries.
|
CtsQueryExpr |
andQuery(CtsQueryExpr... queries) |
Returns a query specifying the intersection of
the matches specified by the sub-queries.
|
CtsQueryExpr |
andQuery(ServerExpression queries) |
Returns a query specifying the intersection of
the matches specified by the sub-queries.
|
CtsQueryExpr |
andQuery(ServerExpression queries,
XsStringSeqVal options) |
Returns a query specifying the intersection of
the matches specified by the sub-queries.
|
CtsQueryExpr |
andQuery(ServerExpression queries,
java.lang.String options) |
Returns a query specifying the intersection of
the matches specified by the sub-queries.
|
CtsQueryExpr |
beforeQuery(ServerExpression timestamp) |
Returns a query matching fragments committed
before or at a specified timestamp.
|
CtsQueryExpr |
boostQuery(ServerExpression matchingQuery,
ServerExpression boostingQuery) |
Returns a query specifying that matches to
matching-query should have their search relevance scores boosted if
they also match boosting-query.
|
CtsBoxExpr |
box(double south,
double west, double north, double east) |
Returns a geospatial box value.
|
CtsBoxExpr |
box(ServerExpression south,
ServerExpression west,
ServerExpression north,
ServerExpression east) |
Returns a geospatial box value.
|
ServerExpression |
boxEast(ServerExpression box) |
Returns a box's eastern boundary.
|
ServerExpression |
boxNorth(ServerExpression box) |
Returns a box's northern boundary.
|
CtsBoxSeqExpr |
boxSeq(CtsBoxExpr... items) |
Constructs a sequence of CtsBoxExpr items.
|
ServerExpression |
boxSouth(ServerExpression box) |
Returns a box's southern boundary.
|
ServerExpression |
boxWest(ServerExpression box) |
Returns a box's western boundary.
|
CtsCircleExpr |
circle(double radius,
ServerExpression center) |
Returns a geospatial circle value.
|
CtsCircleExpr |
circle(ServerExpression radius,
ServerExpression center) |
Returns a geospatial circle value.
|
CtsPointExpr |
circleCenter(ServerExpression circle) |
Returns a circle's center point.
|
ServerExpression |
circleRadius(ServerExpression circle) |
Returns a circle's radius.
|
CtsCircleSeqExpr |
circleSeq(CtsCircleExpr... items) |
Constructs a sequence of CtsCircleExpr
items.
|
CtsQueryExpr |
collectionQuery(ServerExpression uris) |
Match documents in at least one of the specified
collections.
|
CtsQueryExpr |
collectionQuery(java.lang.String uris) |
Match documents in at least one of the specified
collections.
|
CtsReferenceExpr |
collectionReference() |
Creates a reference to the collection lexicon,
for use as a parameter to cts:value-tuples.
|
CtsReferenceExpr |
collectionReference(ServerExpression options) |
Creates a reference to the collection lexicon,
for use as a parameter to cts:value-tuples.
|
CtsReferenceExpr |
collectionReference(java.lang.String options) |
Creates a reference to the collection lexicon,
for use as a parameter to cts:value-tuples.
|
CtsQueryExpr |
columnRangeQuery(ServerExpression schema,
ServerExpression view,
ServerExpression column,
ServerExpression value) |
Returns a cts:query matching documents matching
a TDE-view column equals to an value.
|
CtsQueryExpr |
columnRangeQuery(ServerExpression schema,
ServerExpression view,
ServerExpression column,
ServerExpression value,
ServerExpression operator) |
Returns a cts:query matching documents matching
a TDE-view column equals to an value.
|
CtsQueryExpr |
columnRangeQuery(ServerExpression schema,
ServerExpression view,
ServerExpression column,
ServerExpression value,
ServerExpression operator,
ServerExpression options) |
Returns a cts:query matching documents matching
a TDE-view column equals to an value.
|
CtsQueryExpr |
columnRangeQuery(ServerExpression schema,
ServerExpression view,
ServerExpression column,
ServerExpression value,
ServerExpression operator,
ServerExpression options,
ServerExpression weight) |
Returns a cts:query matching documents matching
a TDE-view column equals to an value.
|
CtsQueryExpr |
columnRangeQuery(java.lang.String schema,
java.lang.String view, java.lang.String column,
java.lang.String value) |
Returns a cts:query matching documents matching
a TDE-view column equals to an value.
|
CtsQueryExpr |
columnRangeQuery(java.lang.String schema,
java.lang.String view, java.lang.String column,
java.lang.String value,
java.lang.String operator) |
Returns a cts:query matching documents matching
a TDE-view column equals to an value.
|
CtsQueryExpr |
columnRangeQuery(java.lang.String schema,
java.lang.String view, java.lang.String column,
java.lang.String value, java.lang.String operator,
java.lang.String... options) |
Returns a cts:query matching documents matching
a TDE-view column equals to an value.
|
CtsQueryExpr |
columnRangeQuery(java.lang.String schema,
java.lang.String view, java.lang.String column,
java.lang.String value, java.lang.String operator,
java.lang.String options, double weight) |
Returns a cts:query matching documents matching
a TDE-view column equals to an value.
|
CtsPolygonExpr |
complexPolygon(ServerExpression outer,
ServerExpression inner) |
Returns a geospatial complex polygon
value.
|
CtsQueryExpr |
directoryQuery(ServerExpression uris) |
Returns a query matching documents in the
directories with the given URIs.
|
CtsQueryExpr |
directoryQuery(ServerExpression uris,
ServerExpression depth) |
Returns a query matching documents in the
directories with the given URIs.
|
CtsQueryExpr |
directoryQuery(java.lang.String uris) |
Returns a query matching documents in the
directories with the given URIs.
|
CtsQueryExpr |
directoryQuery(java.lang.String uris,
java.lang.String depth) |
Returns a query matching documents in the
directories with the given URIs.
|
CtsQueryExpr |
documentFragmentQuery(ServerExpression query) |
Returns a query that matches all documents where
query matches any document fragment.
|
CtsQueryExpr |
documentQuery(ServerExpression uris) |
Returns a query matching documents with the
given URIs.
|
CtsQueryExpr |
documentQuery(java.lang.String uris) |
Returns a query matching documents with the
given URIs.
|
CtsQueryExpr |
elementAttributePairGeospatialQuery(ServerExpression elementName,
ServerExpression latitudeName,
ServerExpression longitudeName,
ServerExpression region) |
Returns a query matching elements by name which
has specific attributes representing latitude and longitude values
for a point contained within the given geographic box, circle, or
polygon, or equal to the given point.
|
CtsQueryExpr |
elementAttributePairGeospatialQuery(ServerExpression elementName,
ServerExpression latitudeName,
ServerExpression longitudeName,
ServerExpression region,
ServerExpression options) |
Returns a query matching elements by name which
has specific attributes representing latitude and longitude values
for a point contained within the given geographic box, circle, or
polygon, or equal to the given point.
|
CtsQueryExpr |
elementAttributePairGeospatialQuery(ServerExpression elementName,
ServerExpression latitudeName,
ServerExpression longitudeName,
ServerExpression region,
ServerExpression options,
ServerExpression weight) |
Returns a query matching elements by name which
has specific attributes representing latitude and longitude values
for a point contained within the given geographic box, circle, or
polygon, or equal to the given point.
|
CtsQueryExpr |
elementAttributePairGeospatialQuery(java.lang.String elementName,
java.lang.String latitudeName,
java.lang.String longitudeName, CtsRegionExpr... region) |
Returns a query matching elements by name which
has specific attributes representing latitude and longitude values
for a point contained within the given geographic box, circle, or
polygon, or equal to the given point.
|
CtsQueryExpr |
elementAttributePairGeospatialQuery(java.lang.String elementName,
java.lang.String latitudeName,
java.lang.String longitudeName, ServerExpression region,
java.lang.String... options) |
Returns a query matching elements by name which
has specific attributes representing latitude and longitude values
for a point contained within the given geographic box, circle, or
polygon, or equal to the given point.
|
CtsQueryExpr |
elementAttributePairGeospatialQuery(java.lang.String elementName,
java.lang.String latitudeName,
java.lang.String longitudeName, ServerExpression region,
java.lang.String options, double weight) |
Returns a query matching elements by name which
has specific attributes representing latitude and longitude values
for a point contained within the given geographic box, circle, or
polygon, or equal to the given point.
|
CtsQueryExpr |
elementAttributeRangeQuery(ServerExpression elementName,
ServerExpression attributeName,
ServerExpression operator,
ServerExpression value) |
Constructs a query that matches
element-attributes by name with a range-index entry equal to a
given value.
|
CtsQueryExpr |
elementAttributeRangeQuery(ServerExpression elementName,
ServerExpression attributeName,
ServerExpression operator,
ServerExpression value,
ServerExpression options) |
Constructs a query that matches
element-attributes by name with a range-index entry equal to a
given value.
|
CtsQueryExpr |
elementAttributeRangeQuery(ServerExpression elementName,
ServerExpression attributeName,
ServerExpression operator,
ServerExpression value,
ServerExpression options,
ServerExpression weight) |
Constructs a query that matches
element-attributes by name with a range-index entry equal to a
given value.
|
CtsQueryExpr |
elementAttributeRangeQuery(java.lang.String elementName,
java.lang.String attributeName,
java.lang.String operator,
java.lang.String value) |
Constructs a query that matches
element-attributes by name with a range-index entry equal to a
given value.
|
CtsQueryExpr |
elementAttributeRangeQuery(java.lang.String elementName,
java.lang.String attributeName,
java.lang.String operator, java.lang.String value,
java.lang.String... options) |
Constructs a query that matches
element-attributes by name with a range-index entry equal to a
given value.
|
CtsQueryExpr |
elementAttributeRangeQuery(java.lang.String elementName,
java.lang.String attributeName,
java.lang.String operator, java.lang.String value,
java.lang.String options, double weight) |
Constructs a query that matches
element-attributes by name with a range-index entry equal to a
given value.
|
CtsReferenceExpr |
elementAttributeReference(ServerExpression element,
ServerExpression attribute) |
Creates a reference to an element attribute
value lexicon, for use as a parameter to cts:value-tuples.
|
CtsReferenceExpr |
elementAttributeReference(ServerExpression element,
ServerExpression attribute,
ServerExpression options) |
Creates a reference to an element attribute
value lexicon, for use as a parameter to cts:value-tuples.
|
CtsReferenceExpr |
elementAttributeReference(java.lang.String element,
java.lang.String attribute) |
Creates a reference to an element attribute
value lexicon, for use as a parameter to cts:value-tuples.
|
CtsReferenceExpr |
elementAttributeReference(java.lang.String element,
java.lang.String attribute,
java.lang.String options) |
Creates a reference to an element attribute
value lexicon, for use as a parameter to cts:value-tuples.
|
CtsQueryExpr |
elementAttributeValueQuery(ServerExpression elementName,
ServerExpression attributeName,
ServerExpression text) |
Returns a query matching elements by name with
attributes by name with text content equal a given phrase.
|
CtsQueryExpr |
elementAttributeValueQuery(ServerExpression elementName,
ServerExpression attributeName,
ServerExpression text,
ServerExpression options) |
Returns a query matching elements by name with
attributes by name with text content equal a given phrase.
|
CtsQueryExpr |
elementAttributeValueQuery(ServerExpression elementName,
ServerExpression attributeName,
ServerExpression text,
ServerExpression options,
ServerExpression weight) |
Returns a query matching elements by name with
attributes by name with text content equal a given phrase.
|
CtsQueryExpr |
elementAttributeValueQuery(java.lang.String elementName,
java.lang.String attributeName,
java.lang.String text) |
Returns a query matching elements by name with
attributes by name with text content equal a given phrase.
|
CtsQueryExpr |
elementAttributeValueQuery(java.lang.String elementName,
java.lang.String attributeName, java.lang.String text,
java.lang.String... options) |
Returns a query matching elements by name with
attributes by name with text content equal a given phrase.
|
CtsQueryExpr |
elementAttributeValueQuery(java.lang.String elementName,
java.lang.String attributeName, java.lang.String text,
java.lang.String options, double weight) |
Returns a query matching elements by name with
attributes by name with text content equal a given phrase.
|
CtsQueryExpr |
elementAttributeWordQuery(ServerExpression elementName,
ServerExpression attributeName,
ServerExpression text) |
Returns a query matching elements by name with
attributes by name with text content containing a given
phrase.
|
CtsQueryExpr |
elementAttributeWordQuery(ServerExpression elementName,
ServerExpression attributeName,
ServerExpression text,
ServerExpression options) |
Returns a query matching elements by name with
attributes by name with text content containing a given
phrase.
|
CtsQueryExpr |
elementAttributeWordQuery(ServerExpression elementName,
ServerExpression attributeName,
ServerExpression text,
ServerExpression options,
ServerExpression weight) |
Returns a query matching elements by name with
attributes by name with text content containing a given
phrase.
|
CtsQueryExpr |
elementAttributeWordQuery(java.lang.String elementName,
java.lang.String attributeName,
java.lang.String text) |
Returns a query matching elements by name with
attributes by name with text content containing a given
phrase.
|
CtsQueryExpr |
elementAttributeWordQuery(java.lang.String elementName,
java.lang.String attributeName, java.lang.String text,
java.lang.String... options) |
Returns a query matching elements by name with
attributes by name with text content containing a given
phrase.
|
CtsQueryExpr |
elementAttributeWordQuery(java.lang.String elementName,
java.lang.String attributeName, java.lang.String text,
java.lang.String options, double weight) |
Returns a query matching elements by name with
attributes by name with text content containing a given
phrase.
|
CtsQueryExpr |
elementChildGeospatialQuery(ServerExpression elementName,
ServerExpression childName,
ServerExpression region) |
Returns a query matching elements by name which
has specific element children representing latitude and longitude
values for a point contained within the given geographic box,
circle, or polygon, or equal to the given point.
|
CtsQueryExpr |
elementChildGeospatialQuery(ServerExpression elementName,
ServerExpression childName,
ServerExpression region,
ServerExpression options) |
Returns a query matching elements by name which
has specific element children representing latitude and longitude
values for a point contained within the given geographic box,
circle, or polygon, or equal to the given point.
|
CtsQueryExpr |
elementChildGeospatialQuery(ServerExpression elementName,
ServerExpression childName,
ServerExpression region,
ServerExpression options,
ServerExpression weight) |
Returns a query matching elements by name which
has specific element children representing latitude and longitude
values for a point contained within the given geographic box,
circle, or polygon, or equal to the given point.
|
CtsQueryExpr |
elementChildGeospatialQuery(java.lang.String elementName,
java.lang.String childName, CtsRegionExpr... region) |
Returns a query matching elements by name which
has specific element children representing latitude and longitude
values for a point contained within the given geographic box,
circle, or polygon, or equal to the given point.
|
CtsQueryExpr |
elementChildGeospatialQuery(java.lang.String elementName,
java.lang.String childName, ServerExpression region,
java.lang.String... options) |
Returns a query matching elements by name which
has specific element children representing latitude and longitude
values for a point contained within the given geographic box,
circle, or polygon, or equal to the given point.
|
CtsQueryExpr |
elementChildGeospatialQuery(java.lang.String elementName,
java.lang.String childName, ServerExpression region,
java.lang.String options, double weight) |
Returns a query matching elements by name which
has specific element children representing latitude and longitude
values for a point contained within the given geographic box,
circle, or polygon, or equal to the given point.
|
CtsQueryExpr |
elementGeospatialQuery(ServerExpression elementName,
ServerExpression region) |
Returns a query matching elements by name whose
content represents a point contained within the given geographic
box, circle, or polygon, or equal to the given point.
|
CtsQueryExpr |
elementGeospatialQuery(ServerExpression elementName,
ServerExpression region,
ServerExpression options) |
Returns a query matching elements by name whose
content represents a point contained within the given geographic
box, circle, or polygon, or equal to the given point.
|
CtsQueryExpr |
elementGeospatialQuery(ServerExpression elementName,
ServerExpression region,
ServerExpression options,
ServerExpression weight) |
Returns a query matching elements by name whose
content represents a point contained within the given geographic
box, circle, or polygon, or equal to the given point.
|
CtsQueryExpr |
elementGeospatialQuery(java.lang.String elementName,
CtsRegionExpr... region) |
Returns a query matching elements by name whose
content represents a point contained within the given geographic
box, circle, or polygon, or equal to the given point.
|
CtsQueryExpr |
elementGeospatialQuery(java.lang.String elementName,
ServerExpression region,
java.lang.String... options) |
Returns a query matching elements by name whose
content represents a point contained within the given geographic
box, circle, or polygon, or equal to the given point.
|
CtsQueryExpr |
elementGeospatialQuery(java.lang.String elementName,
ServerExpression region,
java.lang.String options, double weight) |
Returns a query matching elements by name whose
content represents a point contained within the given geographic
box, circle, or polygon, or equal to the given point.
|
CtsQueryExpr |
elementPairGeospatialQuery(ServerExpression elementName,
ServerExpression latitudeName,
ServerExpression longitudeName,
ServerExpression region) |
Returns a query matching elements by name which
has specific element children representing latitude and longitude
values for a point contained within the given geographic box,
circle, or polygon, or equal to the given point.
|
CtsQueryExpr |
elementPairGeospatialQuery(ServerExpression elementName,
ServerExpression latitudeName,
ServerExpression longitudeName,
ServerExpression region,
ServerExpression options) |
Returns a query matching elements by name which
has specific element children representing latitude and longitude
values for a point contained within the given geographic box,
circle, or polygon, or equal to the given point.
|
CtsQueryExpr |
elementPairGeospatialQuery(ServerExpression elementName,
ServerExpression latitudeName,
ServerExpression longitudeName,
ServerExpression region,
ServerExpression options,
ServerExpression weight) |
Returns a query matching elements by name which
has specific element children representing latitude and longitude
values for a point contained within the given geographic box,
circle, or polygon, or equal to the given point.
|
CtsQueryExpr |
elementPairGeospatialQuery(java.lang.String elementName,
java.lang.String latitudeName,
java.lang.String longitudeName, CtsRegionExpr... region) |
Returns a query matching elements by name which
has specific element children representing latitude and longitude
values for a point contained within the given geographic box,
circle, or polygon, or equal to the given point.
|
CtsQueryExpr |
elementPairGeospatialQuery(java.lang.String elementName,
java.lang.String latitudeName,
java.lang.String longitudeName, ServerExpression region,
java.lang.String... options) |
Returns a query matching elements by name which
has specific element children representing latitude and longitude
values for a point contained within the given geographic box,
circle, or polygon, or equal to the given point.
|
CtsQueryExpr |
elementPairGeospatialQuery(java.lang.String elementName,
java.lang.String latitudeName,
java.lang.String longitudeName, ServerExpression region,
java.lang.String options, double weight) |
Returns a query matching elements by name which
has specific element children representing latitude and longitude
values for a point contained within the given geographic box,
circle, or polygon, or equal to the given point.
|
CtsQueryExpr |
elementQuery(ServerExpression elementName,
ServerExpression query) |
Constructs a query that matches elements by name
with the content constrained by the query given in the second
parameter.
|
CtsQueryExpr |
elementQuery(java.lang.String elementName,
ServerExpression query) |
Constructs a query that matches elements by name
with the content constrained by the query given in the second
parameter.
|
CtsQueryExpr |
elementRangeQuery(ServerExpression elementName,
ServerExpression operator,
ServerExpression value) |
Constructs a query that matches elements by name
with range index entry equal to a given value.
|
CtsQueryExpr |
elementRangeQuery(ServerExpression elementName,
ServerExpression operator,
ServerExpression value,
ServerExpression options) |
Constructs a query that matches elements by name
with range index entry equal to a given value.
|
CtsQueryExpr |
elementRangeQuery(ServerExpression elementName,
ServerExpression operator,
ServerExpression value,
ServerExpression options,
ServerExpression weight) |
Constructs a query that matches elements by name
with range index entry equal to a given value.
|
CtsQueryExpr |
elementRangeQuery(java.lang.String elementName,
java.lang.String operator,
java.lang.String value) |
Constructs a query that matches elements by name
with range index entry equal to a given value.
|
CtsQueryExpr |
elementRangeQuery(java.lang.String elementName,
java.lang.String operator, java.lang.String value,
java.lang.String... options) |
Constructs a query that matches elements by name
with range index entry equal to a given value.
|
CtsQueryExpr |
elementRangeQuery(java.lang.String elementName,
java.lang.String operator, java.lang.String value,
java.lang.String options, double weight) |
Constructs a query that matches elements by name
with range index entry equal to a given value.
|
CtsReferenceExpr |
elementReference(ServerExpression element) |
Creates a reference to an element value lexicon,
for use as a parameter to cts:value-tuples, temporal:axis-create,
or any other function that takes an index reference.
|
CtsReferenceExpr |
elementReference(ServerExpression element,
ServerExpression options) |
Creates a reference to an element value lexicon,
for use as a parameter to cts:value-tuples, temporal:axis-create,
or any other function that takes an index reference.
|
CtsReferenceExpr |
elementReference(java.lang.String element) |
Creates a reference to an element value lexicon,
for use as a parameter to cts:value-tuples, temporal:axis-create,
or any other function that takes an index reference.
|
CtsReferenceExpr |
elementReference(java.lang.String element,
java.lang.String options) |
Creates a reference to an element value lexicon,
for use as a parameter to cts:value-tuples, temporal:axis-create,
or any other function that takes an index reference.
|
CtsQueryExpr |
elementValueQuery(ServerExpression elementName) |
Returns a query matching elements by name with
text content equal a given phrase.
|
CtsQueryExpr |
elementValueQuery(ServerExpression elementName,
ServerExpression text) |
Returns a query matching elements by name with
text content equal a given phrase.
|
CtsQueryExpr |
elementValueQuery(ServerExpression elementName,
ServerExpression text,
ServerExpression options) |
Returns a query matching elements by name with
text content equal a given phrase.
|
CtsQueryExpr |
elementValueQuery(ServerExpression elementName,
ServerExpression text,
ServerExpression options,
ServerExpression weight) |
Returns a query matching elements by name with
text content equal a given phrase.
|
CtsQueryExpr |
elementValueQuery(java.lang.String elementName) |
Returns a query matching elements by name with
text content equal a given phrase.
|
CtsQueryExpr |
elementValueQuery(java.lang.String elementName,
java.lang.String text) |
Returns a query matching elements by name with
text content equal a given phrase.
|
CtsQueryExpr |
elementValueQuery(java.lang.String elementName,
java.lang.String text,
java.lang.String... options) |
Returns a query matching elements by name with
text content equal a given phrase.
|
CtsQueryExpr |
elementValueQuery(java.lang.String elementName,
java.lang.String text, java.lang.String options,
double weight) |
Returns a query matching elements by name with
text content equal a given phrase.
|
CtsQueryExpr |
elementWordQuery(ServerExpression elementName,
ServerExpression text) |
Returns a query matching elements by name with
text content containing a given phrase.
|
CtsQueryExpr |
elementWordQuery(ServerExpression elementName,
ServerExpression text,
ServerExpression options) |
Returns a query matching elements by name with
text content containing a given phrase.
|
CtsQueryExpr |
elementWordQuery(ServerExpression elementName,
ServerExpression text,
ServerExpression options,
ServerExpression weight) |
Returns a query matching elements by name with
text content containing a given phrase.
|
CtsQueryExpr |
elementWordQuery(java.lang.String elementName,
java.lang.String text) |
Returns a query matching elements by name with
text content containing a given phrase.
|
CtsQueryExpr |
elementWordQuery(java.lang.String elementName,
java.lang.String text,
java.lang.String... options) |
Returns a query matching elements by name with
text content containing a given phrase.
|
CtsQueryExpr |
elementWordQuery(java.lang.String elementName,
java.lang.String text, java.lang.String options,
double weight) |
Returns a query matching elements by name with
text content containing a given phrase.
|
CtsQueryExpr |
falseQuery() |
Returns a query that matches no fragments.
|
CtsQueryExpr |
fieldRangeQuery(ServerExpression fieldName,
ServerExpression operator,
ServerExpression value) |
Returns a cts:query matching fields by name with
a range-index entry equal to a given value.
|
CtsQueryExpr |
fieldRangeQuery(ServerExpression fieldName,
ServerExpression operator,
ServerExpression value,
ServerExpression options) |
Returns a cts:query matching fields by name with
a range-index entry equal to a given value.
|
CtsQueryExpr |
fieldRangeQuery(ServerExpression fieldName,
ServerExpression operator,
ServerExpression value,
ServerExpression options,
ServerExpression weight) |
Returns a cts:query matching fields by name with
a range-index entry equal to a given value.
|
CtsQueryExpr |
fieldRangeQuery(java.lang.String fieldName,
java.lang.String operator,
java.lang.String value) |
Returns a cts:query matching fields by name with
a range-index entry equal to a given value.
|
CtsQueryExpr |
fieldRangeQuery(java.lang.String fieldName,
java.lang.String operator, java.lang.String value,
java.lang.String... options) |
Returns a cts:query matching fields by name with
a range-index entry equal to a given value.
|
CtsQueryExpr |
fieldRangeQuery(java.lang.String fieldName,
java.lang.String operator, java.lang.String value,
java.lang.String options, double weight) |
Returns a cts:query matching fields by name with
a range-index entry equal to a given value.
|
CtsReferenceExpr |
fieldReference(ServerExpression field) |
Creates a reference to a field value lexicon,
for use as a parameter to cts:value-tuples.
|
CtsReferenceExpr |
fieldReference(ServerExpression field,
ServerExpression options) |
Creates a reference to a field value lexicon,
for use as a parameter to cts:value-tuples.
|
CtsReferenceExpr |
fieldReference(java.lang.String field) |
Creates a reference to a field value lexicon,
for use as a parameter to cts:value-tuples.
|
CtsReferenceExpr |
fieldReference(java.lang.String field,
java.lang.String options) |
Creates a reference to a field value lexicon,
for use as a parameter to cts:value-tuples.
|
CtsQueryExpr |
fieldValueQuery(ServerExpression fieldName,
ServerExpression text) |
Returns a query matching text content containing
a given value in the specified field.
|
CtsQueryExpr |
fieldValueQuery(ServerExpression fieldName,
ServerExpression text,
ServerExpression options) |
Returns a query matching text content containing
a given value in the specified field.
|
CtsQueryExpr |
fieldValueQuery(ServerExpression fieldName,
ServerExpression text,
ServerExpression options,
ServerExpression weight) |
Returns a query matching text content containing
a given value in the specified field.
|
CtsQueryExpr |
fieldValueQuery(java.lang.String fieldName,
java.lang.String text) |
Returns a query matching text content containing
a given value in the specified field.
|
CtsQueryExpr |
fieldValueQuery(java.lang.String fieldName,
java.lang.String text,
java.lang.String... options) |
Returns a query matching text content containing
a given value in the specified field.
|
CtsQueryExpr |
fieldValueQuery(java.lang.String fieldName,
java.lang.String text, java.lang.String options,
double weight) |
Returns a query matching text content containing
a given value in the specified field.
|
CtsQueryExpr |
fieldWordQuery(ServerExpression fieldName,
ServerExpression text) |
Returns a query matching fields with text
content containing a given phrase.
|
CtsQueryExpr |
fieldWordQuery(ServerExpression fieldName,
ServerExpression text,
ServerExpression options) |
Returns a query matching fields with text
content containing a given phrase.
|
CtsQueryExpr |
fieldWordQuery(ServerExpression fieldName,
ServerExpression text,
ServerExpression options,
ServerExpression weight) |
Returns a query matching fields with text
content containing a given phrase.
|
CtsQueryExpr |
fieldWordQuery(java.lang.String fieldName,
java.lang.String text) |
Returns a query matching fields with text
content containing a given phrase.
|
CtsQueryExpr |
fieldWordQuery(java.lang.String fieldName,
java.lang.String text,
java.lang.String... options) |
Returns a query matching fields with text
content containing a given phrase.
|
CtsQueryExpr |
fieldWordQuery(java.lang.String fieldName,
java.lang.String text, java.lang.String options,
double weight) |
Returns a query matching fields with text
content containing a given phrase.
|
CtsReferenceExpr |
geospatialPathReference(ServerExpression pathExpression) |
Creates a reference to a geospatial path range
index, for use as a parameter to cts:value-tuples.
|
CtsReferenceExpr |
geospatialPathReference(ServerExpression pathExpression,
ServerExpression options) |
Creates a reference to a geospatial path range
index, for use as a parameter to cts:value-tuples.
|
CtsReferenceExpr |
geospatialPathReference(ServerExpression pathExpression,
ServerExpression options,
ServerExpression map) |
Creates a reference to a geospatial path range
index, for use as a parameter to cts:value-tuples.
|
CtsReferenceExpr |
geospatialPathReference(java.lang.String pathExpression) |
Creates a reference to a geospatial path range
index, for use as a parameter to cts:value-tuples.
|
CtsReferenceExpr |
geospatialPathReference(java.lang.String pathExpression,
java.lang.String options) |
Creates a reference to a geospatial path range
index, for use as a parameter to cts:value-tuples.
|
CtsReferenceExpr |
geospatialPathReference(java.lang.String pathExpression,
java.lang.String options, ServerExpression map) |
Creates a reference to a geospatial path range
index, for use as a parameter to cts:value-tuples.
|
CtsReferenceExpr |
geospatialRegionPathReference(ServerExpression pathExpression) |
Create a reference to a geospatial region path
index, for use as a parameter to cts:geospatial-region-query and
other query operations on geospatial region indexes.
|
CtsReferenceExpr |
geospatialRegionPathReference(ServerExpression pathExpression,
ServerExpression options) |
Create a reference to a geospatial region path
index, for use as a parameter to cts:geospatial-region-query and
other query operations on geospatial region indexes.
|
CtsReferenceExpr |
geospatialRegionPathReference(ServerExpression pathExpression,
ServerExpression options,
ServerExpression namespaces) |
Create a reference to a geospatial region path
index, for use as a parameter to cts:geospatial-region-query and
other query operations on geospatial region indexes.
|
CtsReferenceExpr |
geospatialRegionPathReference(ServerExpression pathExpression,
ServerExpression options,
ServerExpression namespaces,
ServerExpression geohashPrecision) |
Create a reference to a geospatial region path
index, for use as a parameter to cts:geospatial-region-query and
other query operations on geospatial region indexes.
|
CtsReferenceExpr |
geospatialRegionPathReference(ServerExpression pathExpression,
ServerExpression options,
ServerExpression namespaces,
ServerExpression geohashPrecision,
ServerExpression units) |
Create a reference to a geospatial region path
index, for use as a parameter to cts:geospatial-region-query and
other query operations on geospatial region indexes.
|
CtsReferenceExpr |
geospatialRegionPathReference(ServerExpression pathExpression,
ServerExpression options,
ServerExpression namespaces,
ServerExpression geohashPrecision,
ServerExpression units,
ServerExpression invalidValues) |
Create a reference to a geospatial region path
index, for use as a parameter to cts:geospatial-region-query and
other query operations on geospatial region indexes.
|
CtsReferenceExpr |
geospatialRegionPathReference(java.lang.String pathExpression) |
Create a reference to a geospatial region path
index, for use as a parameter to cts:geospatial-region-query and
other query operations on geospatial region indexes.
|
CtsReferenceExpr |
geospatialRegionPathReference(java.lang.String pathExpression,
java.lang.String options) |
Create a reference to a geospatial region path
index, for use as a parameter to cts:geospatial-region-query and
other query operations on geospatial region indexes.
|
CtsReferenceExpr |
geospatialRegionPathReference(java.lang.String pathExpression,
java.lang.String options, ServerExpression namespaces) |
Create a reference to a geospatial region path
index, for use as a parameter to cts:geospatial-region-query and
other query operations on geospatial region indexes.
|
CtsReferenceExpr |
geospatialRegionPathReference(java.lang.String pathExpression,
java.lang.String options, ServerExpression namespaces,
long geohashPrecision) |
Create a reference to a geospatial region path
index, for use as a parameter to cts:geospatial-region-query and
other query operations on geospatial region indexes.
|
CtsReferenceExpr |
geospatialRegionPathReference(java.lang.String pathExpression,
java.lang.String options, ServerExpression namespaces,
long geohashPrecision,
java.lang.String units) |
Create a reference to a geospatial region path
index, for use as a parameter to cts:geospatial-region-query and
other query operations on geospatial region indexes.
|
CtsReferenceExpr |
geospatialRegionPathReference(java.lang.String pathExpression,
java.lang.String options, ServerExpression namespaces,
long geohashPrecision, java.lang.String units,
java.lang.String invalidValues) |
Create a reference to a geospatial region path
index, for use as a parameter to cts:geospatial-region-query and
other query operations on geospatial region indexes.
|
CtsQueryExpr |
geospatialRegionQuery(ServerExpression reference,
ServerExpression operation,
ServerExpression region) |
Construct a query to match regions in documents
that satisfy a specified relationship relative to other
regions.
|
CtsQueryExpr |
geospatialRegionQuery(ServerExpression reference,
ServerExpression operation,
ServerExpression region,
ServerExpression options) |
Construct a query to match regions in documents
that satisfy a specified relationship relative to other
regions.
|
CtsQueryExpr |
geospatialRegionQuery(ServerExpression reference,
ServerExpression operation,
ServerExpression region,
ServerExpression options,
ServerExpression weight) |
Construct a query to match regions in documents
that satisfy a specified relationship relative to other
regions.
|
CtsQueryExpr |
geospatialRegionQuery(ServerExpression reference,
java.lang.String operation, CtsRegionExpr... region) |
Construct a query to match regions in documents
that satisfy a specified relationship relative to other
regions.
|
CtsQueryExpr |
geospatialRegionQuery(ServerExpression reference,
java.lang.String operation, ServerExpression region,
java.lang.String... options) |
Construct a query to match regions in documents
that satisfy a specified relationship relative to other
regions.
|
CtsQueryExpr |
geospatialRegionQuery(ServerExpression reference,
java.lang.String operation, ServerExpression region,
java.lang.String options, double weight) |
Construct a query to match regions in documents
that satisfy a specified relationship relative to other
regions.
|
CtsReferenceExpr |
iriReference() |
Creates a reference to the URI lexicon, for use
as a parameter to cts:value-tuples.
|
CtsQueryExpr |
jsonPropertyChildGeospatialQuery(ServerExpression propertyName,
ServerExpression childName,
ServerExpression region) |
Returns a query matching json properties by name
which has specific children representing latitude and longitude
values for a point contained within the given geographic box,
circle, or polygon, or equal to the given point.
|
CtsQueryExpr |
jsonPropertyChildGeospatialQuery(ServerExpression propertyName,
ServerExpression childName,
ServerExpression region,
ServerExpression options) |
Returns a query matching json properties by name
which has specific children representing latitude and longitude
values for a point contained within the given geographic box,
circle, or polygon, or equal to the given point.
|
CtsQueryExpr |
jsonPropertyChildGeospatialQuery(ServerExpression propertyName,
ServerExpression childName,
ServerExpression region,
ServerExpression options,
ServerExpression weight) |
Returns a query matching json properties by name
which has specific children representing latitude and longitude
values for a point contained within the given geographic box,
circle, or polygon, or equal to the given point.
|
CtsQueryExpr |
jsonPropertyChildGeospatialQuery(java.lang.String propertyName,
java.lang.String childName, CtsRegionExpr... region) |
Returns a query matching json properties by name
which has specific children representing latitude and longitude
values for a point contained within the given geographic box,
circle, or polygon, or equal to the given point.
|
CtsQueryExpr |
jsonPropertyChildGeospatialQuery(java.lang.String propertyName,
java.lang.String childName, ServerExpression region,
java.lang.String... options) |
Returns a query matching json properties by name
which has specific children representing latitude and longitude
values for a point contained within the given geographic box,
circle, or polygon, or equal to the given point.
|
CtsQueryExpr |
jsonPropertyChildGeospatialQuery(java.lang.String propertyName,
java.lang.String childName, ServerExpression region,
java.lang.String options, double weight) |
Returns a query matching json properties by name
which has specific children representing latitude and longitude
values for a point contained within the given geographic box,
circle, or polygon, or equal to the given point.
|
CtsQueryExpr |
jsonPropertyGeospatialQuery(ServerExpression propertyName,
ServerExpression region) |
Returns a query matching json properties by name
whose content represents a point contained within the given
geographic box, circle, or polygon, or equal to the given
point.
|
CtsQueryExpr |
jsonPropertyGeospatialQuery(ServerExpression propertyName,
ServerExpression region,
ServerExpression options) |
Returns a query matching json properties by name
whose content represents a point contained within the given
geographic box, circle, or polygon, or equal to the given
point.
|
CtsQueryExpr |
jsonPropertyGeospatialQuery(ServerExpression propertyName,
ServerExpression region,
ServerExpression options,
ServerExpression weight) |
Returns a query matching json properties by name
whose content represents a point contained within the given
geographic box, circle, or polygon, or equal to the given
point.
|
CtsQueryExpr |
jsonPropertyGeospatialQuery(java.lang.String propertyName,
CtsRegionExpr... region) |
Returns a query matching json properties by name
whose content represents a point contained within the given
geographic box, circle, or polygon, or equal to the given
point.
|
CtsQueryExpr |
jsonPropertyGeospatialQuery(java.lang.String propertyName,
ServerExpression region,
java.lang.String... options) |
Returns a query matching json properties by name
whose content represents a point contained within the given
geographic box, circle, or polygon, or equal to the given
point.
|
CtsQueryExpr |
jsonPropertyGeospatialQuery(java.lang.String propertyName,
ServerExpression region,
java.lang.String options, double weight) |
Returns a query matching json properties by name
whose content represents a point contained within the given
geographic box, circle, or polygon, or equal to the given
point.
|
CtsQueryExpr |
jsonPropertyPairGeospatialQuery(ServerExpression propertyName,
ServerExpression latitudeName,
ServerExpression longitudeName,
ServerExpression region) |
Returns a query matching json properties by name
which has specific property children representing latitude and
longitude values for a point contained within the given geographic
box, circle, or polygon, or equal to the given point.
|
CtsQueryExpr |
jsonPropertyPairGeospatialQuery(ServerExpression propertyName,
ServerExpression latitudeName,
ServerExpression longitudeName,
ServerExpression region,
ServerExpression options) |
Returns a query matching json properties by name
which has specific property children representing latitude and
longitude values for a point contained within the given geographic
box, circle, or polygon, or equal to the given point.
|
CtsQueryExpr |
jsonPropertyPairGeospatialQuery(ServerExpression propertyName,
ServerExpression latitudeName,
ServerExpression longitudeName,
ServerExpression region,
ServerExpression options,
ServerExpression weight) |
Returns a query matching json properties by name
which has specific property children representing latitude and
longitude values for a point contained within the given geographic
box, circle, or polygon, or equal to the given point.
|
CtsQueryExpr |
jsonPropertyPairGeospatialQuery(java.lang.String propertyName,
java.lang.String latitudeName,
java.lang.String longitudeName, CtsRegionExpr... region) |
Returns a query matching json properties by name
which has specific property children representing latitude and
longitude values for a point contained within the given geographic
box, circle, or polygon, or equal to the given point.
|
CtsQueryExpr |
jsonPropertyPairGeospatialQuery(java.lang.String propertyName,
java.lang.String latitudeName,
java.lang.String longitudeName, ServerExpression region,
java.lang.String... options) |
Returns a query matching json properties by name
which has specific property children representing latitude and
longitude values for a point contained within the given geographic
box, circle, or polygon, or equal to the given point.
|
CtsQueryExpr |
jsonPropertyPairGeospatialQuery(java.lang.String propertyName,
java.lang.String latitudeName,
java.lang.String longitudeName, ServerExpression region,
java.lang.String options, double weight) |
Returns a query matching json properties by name
which has specific property children representing latitude and
longitude values for a point contained within the given geographic
box, circle, or polygon, or equal to the given point.
|
CtsQueryExpr |
jsonPropertyRangeQuery(ServerExpression propertyName,
ServerExpression operator,
ServerExpression value) |
Returns a cts:query matching JSON properties by
name with a range-index entry equal to a given value.
|
CtsQueryExpr |
jsonPropertyRangeQuery(ServerExpression propertyName,
ServerExpression operator,
ServerExpression value,
ServerExpression options) |
Returns a cts:query matching JSON properties by
name with a range-index entry equal to a given value.
|
CtsQueryExpr |
jsonPropertyRangeQuery(ServerExpression propertyName,
ServerExpression operator,
ServerExpression value,
ServerExpression options,
ServerExpression weight) |
Returns a cts:query matching JSON properties by
name with a range-index entry equal to a given value.
|
CtsQueryExpr |
jsonPropertyRangeQuery(java.lang.String propertyName,
java.lang.String operator,
java.lang.String value) |
Returns a cts:query matching JSON properties by
name with a range-index entry equal to a given value.
|
CtsQueryExpr |
jsonPropertyRangeQuery(java.lang.String propertyName,
java.lang.String operator, java.lang.String value,
java.lang.String... options) |
Returns a cts:query matching JSON properties by
name with a range-index entry equal to a given value.
|
CtsQueryExpr |
jsonPropertyRangeQuery(java.lang.String propertyName,
java.lang.String operator, java.lang.String value,
java.lang.String options, double weight) |
Returns a cts:query matching JSON properties by
name with a range-index entry equal to a given value.
|
CtsReferenceExpr |
jsonPropertyReference(ServerExpression property) |
Creates a reference to a JSON property value
lexicon, for use as a parameter to cts:value-tuples.
|
CtsReferenceExpr |
jsonPropertyReference(ServerExpression property,
ServerExpression options) |
Creates a reference to a JSON property value
lexicon, for use as a parameter to cts:value-tuples.
|
CtsReferenceExpr |
jsonPropertyReference(java.lang.String property) |
Creates a reference to a JSON property value
lexicon, for use as a parameter to cts:value-tuples.
|
CtsReferenceExpr |
jsonPropertyReference(java.lang.String property,
java.lang.String options) |
Creates a reference to a JSON property value
lexicon, for use as a parameter to cts:value-tuples.
|
CtsQueryExpr |
jsonPropertyScopeQuery(ServerExpression propertyName,
ServerExpression query) |
Returns a cts:query matching JSON properties by
name with the content constrained by the given cts:query in the
second parameter.
|
CtsQueryExpr |
jsonPropertyScopeQuery(java.lang.String propertyName,
ServerExpression query) |
Returns a cts:query matching JSON properties by
name with the content constrained by the given cts:query in the
second parameter.
|
CtsQueryExpr |
jsonPropertyValueQuery(ServerExpression propertyName,
ServerExpression value) |
Returns a query matching JSON properties by name
with value equal the given value.
|
CtsQueryExpr |
jsonPropertyValueQuery(ServerExpression propertyName,
ServerExpression value,
ServerExpression options) |
Returns a query matching JSON properties by name
with value equal the given value.
|
CtsQueryExpr |
jsonPropertyValueQuery(ServerExpression propertyName,
ServerExpression value,
ServerExpression options,
ServerExpression weight) |
Returns a query matching JSON properties by name
with value equal the given value.
|
CtsQueryExpr |
jsonPropertyValueQuery(java.lang.String propertyName,
java.lang.String value) |
Returns a query matching JSON properties by name
with value equal the given value.
|
CtsQueryExpr |
jsonPropertyValueQuery(java.lang.String propertyName,
java.lang.String value,
java.lang.String... options) |
Returns a query matching JSON properties by name
with value equal the given value.
|
CtsQueryExpr |
jsonPropertyValueQuery(java.lang.String propertyName,
java.lang.String value, java.lang.String options,
double weight) |
Returns a query matching JSON properties by name
with value equal the given value.
|
CtsQueryExpr |
jsonPropertyWordQuery(ServerExpression propertyName,
ServerExpression text) |
Returns a query matching JSON properties by name
with text content containing a given phrase.
|
CtsQueryExpr |
jsonPropertyWordQuery(ServerExpression propertyName,
ServerExpression text,
ServerExpression options) |
Returns a query matching JSON properties by name
with text content containing a given phrase.
|
CtsQueryExpr |
jsonPropertyWordQuery(ServerExpression propertyName,
ServerExpression text,
ServerExpression options,
ServerExpression weight) |
Returns a query matching JSON properties by name
with text content containing a given phrase.
|
CtsQueryExpr |
jsonPropertyWordQuery(java.lang.String propertyName,
java.lang.String text) |
Returns a query matching JSON properties by name
with text content containing a given phrase.
|
CtsQueryExpr |
jsonPropertyWordQuery(java.lang.String propertyName,
java.lang.String text,
java.lang.String... options) |
Returns a query matching JSON properties by name
with text content containing a given phrase.
|
CtsQueryExpr |
jsonPropertyWordQuery(java.lang.String propertyName,
java.lang.String text, java.lang.String options,
double weight) |
Returns a query matching JSON properties by name
with text content containing a given phrase.
|
ServerExpression |
linestring(ServerExpression vertices) |
Returns a geospatial linestring value.
|
ServerExpression |
linestring(java.lang.String vertices) |
Returns a geospatial linestring value.
|
CtsQueryExpr |
locksFragmentQuery(ServerExpression query) |
Returns a query that matches all documents where
query matches document-locks.
|
CtsQueryExpr |
lsqtQuery(ServerExpression temporalCollection) |
Returns only documents before LSQT or a
timestamp before LSQT for stable query results.
|
CtsQueryExpr |
lsqtQuery(ServerExpression temporalCollection,
ServerExpression timestamp) |
Returns only documents before LSQT or a
timestamp before LSQT for stable query results.
|
CtsQueryExpr |
lsqtQuery(ServerExpression temporalCollection,
ServerExpression timestamp,
ServerExpression options) |
Returns only documents before LSQT or a
timestamp before LSQT for stable query results.
|
CtsQueryExpr |
lsqtQuery(ServerExpression temporalCollection,
ServerExpression timestamp,
ServerExpression options,
ServerExpression weight) |
Returns only documents before LSQT or a
timestamp before LSQT for stable query results.
|
CtsQueryExpr |
lsqtQuery(java.lang.String temporalCollection) |
Returns only documents before LSQT or a
timestamp before LSQT for stable query results.
|
CtsQueryExpr |
lsqtQuery(java.lang.String temporalCollection,
java.lang.String timestamp) |
Returns only documents before LSQT or a
timestamp before LSQT for stable query results.
|
CtsQueryExpr |
lsqtQuery(java.lang.String temporalCollection,
java.lang.String timestamp,
java.lang.String... options) |
Returns only documents before LSQT or a
timestamp before LSQT for stable query results.
|
CtsQueryExpr |
lsqtQuery(java.lang.String temporalCollection,
java.lang.String timestamp, java.lang.String options,
double weight) |
Returns only documents before LSQT or a
timestamp before LSQT for stable query results.
|
CtsQueryExpr |
nearQuery(CtsQueryExpr... queries) |
Returns a query matching all of the specified
queries, where the matches occur within the specified distance from
each other.
|
CtsQueryExpr |
nearQuery(ServerExpression queries) |
Returns a query matching all of the specified
queries, where the matches occur within the specified distance from
each other.
|
CtsQueryExpr |
nearQuery(ServerExpression queries,
double distance) |
Returns a query matching all of the specified
queries, where the matches occur within the specified distance from
each other.
|
CtsQueryExpr |
nearQuery(ServerExpression queries,
double distance, java.lang.String... options) |
Returns a query matching all of the specified
queries, where the matches occur within the specified distance from
each other.
|
CtsQueryExpr |
nearQuery(ServerExpression queries,
double distance, java.lang.String options,
double weight) |
Returns a query matching all of the specified
queries, where the matches occur within the specified distance from
each other.
|
CtsQueryExpr |
nearQuery(ServerExpression queries,
ServerExpression distance,
ServerExpression options) |
Returns a query matching all of the specified
queries, where the matches occur within the specified distance from
each other.
|
CtsQueryExpr |
nearQuery(ServerExpression queries,
ServerExpression distance,
ServerExpression options,
ServerExpression weight) |
Returns a query matching all of the specified
queries, where the matches occur within the specified distance from
each other.
|
CtsQueryExpr |
nearQuery(ServerExpression queries,
XsDoubleVal distance) |
Returns a query matching all of the specified
queries, where the matches occur within the specified distance from
each other.
|
CtsQueryExpr |
notInQuery(ServerExpression positiveQuery,
ServerExpression negativeQuery) |
Returns a query matching the first sub-query,
where those matches do not occur within 0 distance of the other
query.
|
CtsQueryExpr |
notQuery(ServerExpression query) |
Returns a query specifying the matches not
specified by its sub-query.
|
CtsQueryExpr |
orQuery(CtsQueryExpr... queries) |
Returns a query specifying the union of the
matches specified by the sub-queries.
|
CtsQueryExpr |
orQuery(ServerExpression queries) |
Returns a query specifying the union of the
matches specified by the sub-queries.
|
CtsQueryExpr |
orQuery(ServerExpression queries,
XsStringSeqVal options) |
Returns a query specifying the union of the
matches specified by the sub-queries.
|
CtsQueryExpr |
orQuery(ServerExpression queries,
java.lang.String options) |
Returns a query specifying the union of the
matches specified by the sub-queries.
|
ServerExpression |
partOfSpeech(ServerExpression token) |
Returns the part of speech for a cts:token, if
any.
|
CtsQueryExpr |
pathGeospatialQuery(ServerExpression pathExpression,
ServerExpression region) |
Returns a query matching path expressions whose
content represents a point contained within the given geographic
box, circle, or polygon, or equal to the given point.
|
CtsQueryExpr |
pathGeospatialQuery(ServerExpression pathExpression,
ServerExpression region,
ServerExpression options) |
Returns a query matching path expressions whose
content represents a point contained within the given geographic
box, circle, or polygon, or equal to the given point.
|
CtsQueryExpr |
pathGeospatialQuery(ServerExpression pathExpression,
ServerExpression region,
ServerExpression options,
ServerExpression weight) |
Returns a query matching path expressions whose
content represents a point contained within the given geographic
box, circle, or polygon, or equal to the given point.
|
CtsQueryExpr |
pathGeospatialQuery(java.lang.String pathExpression,
CtsRegionExpr... region) |
Returns a query matching path expressions whose
content represents a point contained within the given geographic
box, circle, or polygon, or equal to the given point.
|
CtsQueryExpr |
pathGeospatialQuery(java.lang.String pathExpression,
ServerExpression region,
java.lang.String... options) |
Returns a query matching path expressions whose
content represents a point contained within the given geographic
box, circle, or polygon, or equal to the given point.
|
CtsQueryExpr |
pathGeospatialQuery(java.lang.String pathExpression,
ServerExpression region,
java.lang.String options, double weight) |
Returns a query matching path expressions whose
content represents a point contained within the given geographic
box, circle, or polygon, or equal to the given point.
|
CtsQueryExpr |
pathRangeQuery(ServerExpression pathName,
ServerExpression operator,
ServerExpression value) |
Returns a cts:query matching documents where the
content addressed by an XPath expression satisfies the specified
relationship (=, <, >, etc.) with respect to the input
criteria values.
|
CtsQueryExpr |
pathRangeQuery(ServerExpression pathName,
ServerExpression operator,
ServerExpression value,
ServerExpression options) |
Returns a cts:query matching documents where the
content addressed by an XPath expression satisfies the specified
relationship (=, <, >, etc.) with respect to the input
criteria values.
|
CtsQueryExpr |
pathRangeQuery(ServerExpression pathName,
ServerExpression operator,
ServerExpression value,
ServerExpression options,
ServerExpression weight) |
Returns a cts:query matching documents where the
content addressed by an XPath expression satisfies the specified
relationship (=, <, >, etc.) with respect to the input
criteria values.
|
CtsQueryExpr |
pathRangeQuery(java.lang.String pathName,
java.lang.String operator,
java.lang.String value) |
Returns a cts:query matching documents where the
content addressed by an XPath expression satisfies the specified
relationship (=, <, >, etc.) with respect to the input
criteria values.
|
CtsQueryExpr |
pathRangeQuery(java.lang.String pathName,
java.lang.String operator, java.lang.String value,
java.lang.String... options) |
Returns a cts:query matching documents where the
content addressed by an XPath expression satisfies the specified
relationship (=, <, >, etc.) with respect to the input
criteria values.
|
CtsQueryExpr |
pathRangeQuery(java.lang.String pathName,
java.lang.String operator, java.lang.String value,
java.lang.String options, double weight) |
Returns a cts:query matching documents where the
content addressed by an XPath expression satisfies the specified
relationship (=, <, >, etc.) with respect to the input
criteria values.
|
CtsReferenceExpr |
pathReference(ServerExpression pathExpression) |
Creates a reference to a path value lexicon, for
use as a parameter to cts:value-tuples.
|
CtsReferenceExpr |
pathReference(ServerExpression pathExpression,
ServerExpression options) |
Creates a reference to a path value lexicon, for
use as a parameter to cts:value-tuples.
|
CtsReferenceExpr |
pathReference(ServerExpression pathExpression,
ServerExpression options,
ServerExpression map) |
Creates a reference to a path value lexicon, for
use as a parameter to cts:value-tuples.
|
CtsReferenceExpr |
pathReference(java.lang.String pathExpression) |
Creates a reference to a path value lexicon, for
use as a parameter to cts:value-tuples.
|
CtsReferenceExpr |
pathReference(java.lang.String pathExpression,
java.lang.String options) |
Creates a reference to a path value lexicon, for
use as a parameter to cts:value-tuples.
|
CtsReferenceExpr |
pathReference(java.lang.String pathExpression,
java.lang.String options, ServerExpression map) |
Creates a reference to a path value lexicon, for
use as a parameter to cts:value-tuples.
|
CtsPeriodExpr |
period(ServerExpression start,
ServerExpression end) |
Creates a period value, for use as a parameter
to cts:period-range-query or cts:period-compare-query.
|
CtsPeriodExpr |
period(java.lang.String start,
java.lang.String end) |
Creates a period value, for use as a parameter
to cts:period-range-query or cts:period-compare-query.
|
CtsQueryExpr |
periodCompareQuery(ServerExpression axis1,
ServerExpression operator,
ServerExpression axis2) |
Returns a cts:query matching documents that have
relevant pair of period values.
|
CtsQueryExpr |
periodCompareQuery(ServerExpression axis1,
ServerExpression operator,
ServerExpression axis2,
ServerExpression options) |
Returns a cts:query matching documents that have
relevant pair of period values.
|
CtsQueryExpr |
periodCompareQuery(java.lang.String axis1,
java.lang.String operator,
java.lang.String axis2) |
Returns a cts:query matching documents that have
relevant pair of period values.
|
CtsQueryExpr |
periodCompareQuery(java.lang.String axis1,
java.lang.String operator, java.lang.String axis2,
java.lang.String options) |
Returns a cts:query matching documents that have
relevant pair of period values.
|
CtsQueryExpr |
periodRangeQuery(ServerExpression axis,
ServerExpression operator) |
Returns a cts:query matching axis by name with a
period value with an operator.
|
CtsQueryExpr |
periodRangeQuery(ServerExpression axis,
ServerExpression operator,
ServerExpression period) |
Returns a cts:query matching axis by name with a
period value with an operator.
|
CtsQueryExpr |
periodRangeQuery(ServerExpression axis,
ServerExpression operator,
ServerExpression period,
ServerExpression options) |
Returns a cts:query matching axis by name with a
period value with an operator.
|
CtsQueryExpr |
periodRangeQuery(java.lang.String axis,
java.lang.String operator) |
Returns a cts:query matching axis by name with a
period value with an operator.
|
CtsQueryExpr |
periodRangeQuery(java.lang.String axis,
java.lang.String operator, CtsPeriodExpr... period) |
Returns a cts:query matching axis by name with a
period value with an operator.
|
CtsQueryExpr |
periodRangeQuery(java.lang.String axis,
java.lang.String operator, ServerExpression period,
java.lang.String options) |
Returns a cts:query matching axis by name with a
period value with an operator.
|
CtsPeriodSeqExpr |
periodSeq(CtsPeriodExpr... items) |
Constructs a sequence of CtsPeriodExpr
items.
|
CtsPointExpr |
point(double latitude,
double longitude) |
Returns a point value.
|
CtsPointExpr |
point(ServerExpression latitude,
ServerExpression longitude) |
Returns a point value.
|
ServerExpression |
pointLatitude(ServerExpression point) |
Returns a point's latitude value.
|
ServerExpression |
pointLongitude(ServerExpression point) |
Returns a point's longitude value.
|
CtsPointSeqExpr |
pointSeq(CtsPointExpr... items) |
Constructs a sequence of CtsPointExpr
items.
|
CtsPolygonExpr |
polygon(ServerExpression vertices) |
Returns a geospatial polygon value.
|
CtsPolygonSeqExpr |
polygonSeq(CtsPolygonExpr... items) |
Constructs a sequence of CtsPolygonExpr
items.
|
CtsQueryExpr |
propertiesFragmentQuery(ServerExpression query) |
Returns a query that matches all documents where
query matches document-properties.
|
CtsQuerySeqExpr |
querySeq(CtsQueryExpr... items) |
Constructs a sequence of CtsQueryExpr
items.
|
CtsQueryExpr |
rangeQuery(ServerExpression index,
ServerExpression operator,
ServerExpression value) |
Returns a cts:query matching specified nodes
with a range-index entry compared to a given value.
|
CtsQueryExpr |
rangeQuery(ServerExpression index,
ServerExpression operator,
ServerExpression value,
ServerExpression options) |
Returns a cts:query matching specified nodes
with a range-index entry compared to a given value.
|
CtsQueryExpr |
rangeQuery(ServerExpression index,
ServerExpression operator,
ServerExpression value,
ServerExpression options,
ServerExpression weight) |
Returns a cts:query matching specified nodes
with a range-index entry compared to a given value.
|
CtsQueryExpr |
rangeQuery(ServerExpression index,
java.lang.String operator,
java.lang.String value) |
Returns a cts:query matching specified nodes
with a range-index entry compared to a given value.
|
CtsQueryExpr |
rangeQuery(ServerExpression index,
java.lang.String operator, java.lang.String value,
java.lang.String... options) |
Returns a cts:query matching specified nodes
with a range-index entry compared to a given value.
|
CtsQueryExpr |
rangeQuery(ServerExpression index,
java.lang.String operator, java.lang.String value,
java.lang.String options, double weight) |
Returns a cts:query matching specified nodes
with a range-index entry compared to a given value.
|
CtsReferenceSeqExpr |
referenceSeq(CtsReferenceExpr... items) |
Constructs a sequence of CtsReferenceExpr
items.
|
CtsRegionSeqExpr |
regionSeq(CtsRegionExpr... items) |
Constructs a sequence of CtsRegionExpr
items.
|
ServerExpression |
stem(ServerExpression text) |
Returns the stem(s) for a word.
|
ServerExpression |
stem(ServerExpression text,
ServerExpression language) |
Returns the stem(s) for a word.
|
ServerExpression |
stem(ServerExpression text,
ServerExpression language,
ServerExpression partOfSpeech) |
Returns the stem(s) for a word.
|
ServerExpression |
stem(ServerExpression text,
java.lang.String language) |
Returns the stem(s) for a word.
|
ServerExpression |
stem(ServerExpression text,
java.lang.String language,
java.lang.String partOfSpeech) |
Returns the stem(s) for a word.
|
ServerExpression |
tokenize(ServerExpression text) |
Tokenizes text into words, punctuation, and
spaces.
|
ServerExpression |
tokenize(ServerExpression text,
ServerExpression language) |
Tokenizes text into words, punctuation, and
spaces.
|
ServerExpression |
tokenize(ServerExpression text,
ServerExpression language,
ServerExpression field) |
Tokenizes text into words, punctuation, and
spaces.
|
ServerExpression |
tokenize(ServerExpression text,
java.lang.String language) |
Tokenizes text into words, punctuation, and
spaces.
|
ServerExpression |
tokenize(ServerExpression text,
java.lang.String language,
java.lang.String field) |
Tokenizes text into words, punctuation, and
spaces.
|
CtsQueryExpr |
tripleRangeQuery(ServerExpression subject,
ServerExpression predicate,
ServerExpression object) |
Returns a cts:query matching triples with a
triple index entry equal to the given values.
|
CtsQueryExpr |
tripleRangeQuery(ServerExpression subject,
ServerExpression predicate,
ServerExpression object,
ServerExpression operator) |
Returns a cts:query matching triples with a
triple index entry equal to the given values.
|
CtsQueryExpr |
tripleRangeQuery(ServerExpression subject,
ServerExpression predicate,
ServerExpression object,
ServerExpression operator,
ServerExpression options) |
Returns a cts:query matching triples with a
triple index entry equal to the given values.
|
CtsQueryExpr |
tripleRangeQuery(ServerExpression subject,
ServerExpression predicate,
ServerExpression object,
ServerExpression operator,
ServerExpression options,
ServerExpression weight) |
Returns a cts:query matching triples with a
triple index entry equal to the given values.
|
CtsQueryExpr |
tripleRangeQuery(java.lang.String subject,
java.lang.String predicate,
java.lang.String object) |
Returns a cts:query matching triples with a
triple index entry equal to the given values.
|
CtsQueryExpr |
tripleRangeQuery(java.lang.String subject,
java.lang.String predicate, java.lang.String object,
java.lang.String operator) |
Returns a cts:query matching triples with a
triple index entry equal to the given values.
|
CtsQueryExpr |
tripleRangeQuery(java.lang.String subject,
java.lang.String predicate, java.lang.String object,
java.lang.String operator,
java.lang.String... options) |
Returns a cts:query matching triples with a
triple index entry equal to the given values.
|
CtsQueryExpr |
tripleRangeQuery(java.lang.String subject,
java.lang.String predicate, java.lang.String object,
java.lang.String operator, java.lang.String options,
double weight) |
Returns a cts:query matching triples with a
triple index entry equal to the given values.
|
CtsQueryExpr |
trueQuery() |
Returns a query that matches all
fragments.
|
CtsReferenceExpr |
uriReference() |
Creates a reference to the URI lexicon, for use
as a parameter to cts:value-tuples.
|
CtsQueryExpr |
wordQuery(ServerExpression text) |
Returns a query matching text content containing
a given phrase.
|
CtsQueryExpr |
wordQuery(ServerExpression text,
ServerExpression options) |
Returns a query matching text content containing
a given phrase.
|
CtsQueryExpr |
wordQuery(ServerExpression text,
ServerExpression options,
ServerExpression weight) |
Returns a query matching text content containing
a given phrase.
|
CtsQueryExpr |
wordQuery(java.lang.String text) |
Returns a query matching text content containing
a given phrase.
|
CtsQueryExpr |
wordQuery(java.lang.String text,
java.lang.String... options) |
Returns a query matching text content containing
a given phrase.
|
CtsQueryExpr |
wordQuery(java.lang.String text,
java.lang.String options, double weight) |
Returns a query matching text content containing
a given phrase.
|
CtsQueryExpr afterQuery(ServerExpression timestamp)
Provides a client interface to the cts:after-query server function.
timestamp - A commit timestamp. Database fragments
committed after this timestamp are matched. (of xs:unsignedLong)CtsQueryExpr andNotQuery(ServerExpression positiveQuery, ServerExpression negativeQuery)
Provides a client interface to the cts:and-not-query server function.
CtsQueryExpr andQuery(CtsQueryExpr... queries)
Provides a client interface to the cts:and-query server function.
CtsQueryExpr andQuery(ServerExpression queries)
Provides a client interface to the cts:and-query server function.
CtsQueryExpr andQuery(ServerExpression queries, java.lang.String options)
Provides a client interface to the cts:and-query server function.
queries - A sequence of sub-queries. (of cts:query)options - Options to this query. The default is
(). Options include: "ordered" An ordered and-query, which
specifies that the sub-query matches must occur in the order of the
specified sub-queries. For example, if the sub-queries are "cat"
and "dog", an ordered query will only match fragments where both
"cat" and "dog" occur, and where "cat" comes before "dog" in the
fragment. "unordered" An unordered and-query, which specifies that
the sub-query matches can occur in any order. (of xs:string)CtsQueryExpr andQuery(ServerExpression queries, XsStringSeqVal options)
Provides a client interface to the cts:and-query server function.
queries - A sequence of sub-queries. (of cts:query)options - Options to this query. The default is
(). Options include: "ordered" An ordered and-query, which
specifies that the sub-query matches must occur in the order of the
specified sub-queries. For example, if the sub-queries are "cat"
and "dog", an ordered query will only match fragments where both
"cat" and "dog" occur, and where "cat" comes before "dog" in the
fragment. "unordered" An unordered and-query, which specifies that
the sub-query matches can occur in any order. (of xs:string)CtsQueryExpr beforeQuery(ServerExpression timestamp)
Provides a client interface to the cts:before-query server function.
timestamp - A commit timestamp. Database fragments
committed before this timestamp are matched. (of xs:unsignedLong)CtsQueryExpr boostQuery(ServerExpression matchingQuery, ServerExpression boostingQuery)
Provides a client interface to the cts:boost-query server function.
CtsBoxExpr box(double south, double west, double north, double east)
Provides a client interface to the cts:box server function.
CtsBoxExpr box(ServerExpression south, ServerExpression west, ServerExpression north, ServerExpression east)
Provides a client interface to the cts:box server function.
ServerExpression boxEast(ServerExpression box)
Provides a client interface to the cts:box-east server function.
box - The box. (of cts:box)ServerExpression boxNorth(ServerExpression box)
Provides a client interface to the cts:box-north server function.
box - The box. (of cts:box)ServerExpression boxSouth(ServerExpression box)
Provides a client interface to the cts:box-south server function.
box - The box. (of cts:box)ServerExpression boxWest(ServerExpression box)
Provides a client interface to the cts:box-west server function.
box - The box. (of cts:box)CtsCircleExpr circle(double radius, ServerExpression center)
Provides a client interface to the cts:circle server function.
radius - The radius of the circle. The units for
the radius is determined at runtime by the query options (miles is
currently the only option). (of xs:double)center - A point representing the center of the
circle. (of cts:point)CtsCircleExpr circle(ServerExpression radius, ServerExpression center)
Provides a client interface to the cts:circle server function.
radius - The radius of the circle. The units for
the radius is determined at runtime by the query options (miles is
currently the only option). (of xs:double)center - A point representing the center of the
circle. (of cts:point)CtsPointExpr circleCenter(ServerExpression circle)
Provides a client interface to the cts:circle-center server function.
circle - The circle. (of cts:circle)ServerExpression circleRadius(ServerExpression circle)
Provides a client interface to the cts:circle-radius server function.
circle - The circle. (of cts:circle)CtsQueryExpr collectionQuery(java.lang.String uris)
Provides a client interface to the cts:collection-query server function.
CtsQueryExpr collectionQuery(ServerExpression uris)
Provides a client interface to the cts:collection-query server function.
CtsReferenceExpr collectionReference()
Provides a client interface to the cts:collection-reference server function.
CtsReferenceExpr collectionReference(java.lang.String options)
Provides a client interface to the cts:collection-reference server function.
options - Options. The default is (). Options
include: "nullable" Allow null values in tuples reported from
cts:value-tuples when using this lexicon. "unchecked" Do not check
the definition against the context database. (of xs:string)CtsReferenceExpr collectionReference(ServerExpression options)
Provides a client interface to the cts:collection-reference server function.
options - Options. The default is (). Options
include: "nullable" Allow null values in tuples reported from
cts:value-tuples when using this lexicon. "unchecked" Do not check
the definition against the context database. (of xs:string)CtsQueryExpr columnRangeQuery(java.lang.String schema, java.lang.String view, java.lang.String column, java.lang.String value)
Provides a client interface to the cts:column-range-query server function.
schema - The TDE schema name. (of xs:string)view - The TDE view name. (of xs:string)column - The TDE column name. (of xs:string)value - One or more values used for querying. (of
xs:anyAtomicType)CtsQueryExpr columnRangeQuery(ServerExpression schema, ServerExpression view, ServerExpression column, ServerExpression value)
Provides a client interface to the cts:column-range-query server function.
schema - The TDE schema name. (of xs:string)view - The TDE view name. (of xs:string)column - The TDE column name. (of xs:string)value - One or more values used for querying. (of
xs:anyAtomicType)CtsQueryExpr columnRangeQuery(java.lang.String schema, java.lang.String view, java.lang.String column, java.lang.String value, java.lang.String operator)
Provides a client interface to the cts:column-range-query server function.
schema - The TDE schema name. (of xs:string)view - The TDE view name. (of xs:string)column - The TDE column name. (of xs:string)value - One or more values used for querying. (of
xs:anyAtomicType)operator - Operator for the $value values. The
default operator is "=". Operators include: "<" Match range
index values less than $value. "<=" Match range index values
less than or equal to $value. ">" Match range index values
greater than $value. ">=" Match range index values greater than
or equal to $value. "=" Match range index values equal to $value.
"!=" Match range index values not equal to $value. (of xs:string)CtsQueryExpr columnRangeQuery(ServerExpression schema, ServerExpression view, ServerExpression column, ServerExpression value, ServerExpression operator)
Provides a client interface to the cts:column-range-query server function.
schema - The TDE schema name. (of xs:string)view - The TDE view name. (of xs:string)column - The TDE column name. (of xs:string)value - One or more values used for querying. (of
xs:anyAtomicType)operator - Operator for the $value values. The
default operator is "=". Operators include: "<" Match range
index values less than $value. "<=" Match range index values
less than or equal to $value. ">" Match range index values
greater than $value. ">=" Match range index values greater than
or equal to $value. "=" Match range index values equal to $value.
"!=" Match range index values not equal to $value. (of xs:string)CtsQueryExpr columnRangeQuery(java.lang.String schema, java.lang.String view, java.lang.String column, java.lang.String value, java.lang.String operator, java.lang.String... options)
Provides a client interface to the cts:column-range-query server function.
schema - The TDE schema name. (of xs:string)view - The TDE view name. (of xs:string)column - The TDE column name. (of xs:string)value - One or more values used for querying. (of
xs:anyAtomicType)operator - Operator for the $value values. The
default operator is "=". Operators include: "<" Match range
index values less than $value. "<=" Match range index values
less than or equal to $value. ">" Match range index values
greater than $value. ">=" Match range index values greater than
or equal to $value. "=" Match range index values equal to $value.
"!=" Match range index values not equal to $value. (of xs:string)options - Options to this query. The default is
(). Options include: "cached" Cache the results of this query in
the list cache. "uncached" Do not cache the results of this query
in the list cache. "score-function=function" Use the selected
scoring function. The score function may be: linearUse a linear
function of the difference between the specified query value and
the matching value in the index to calculate a score for this range
query. reciprocalUse a reciprocal function of the difference
between the specified query value and the matching value in the
index to calculate a score for this range query. zeroThis range
query does not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. (of xs:string)CtsQueryExpr columnRangeQuery(ServerExpression schema, ServerExpression view, ServerExpression column, ServerExpression value, ServerExpression operator, ServerExpression options)
Provides a client interface to the cts:column-range-query server function.
schema - The TDE schema name. (of xs:string)view - The TDE view name. (of xs:string)column - The TDE column name. (of xs:string)value - One or more values used for querying. (of
xs:anyAtomicType)operator - Operator for the $value values. The
default operator is "=". Operators include: "<" Match range
index values less than $value. "<=" Match range index values
less than or equal to $value. ">" Match range index values
greater than $value. ">=" Match range index values greater than
or equal to $value. "=" Match range index values equal to $value.
"!=" Match range index values not equal to $value. (of xs:string)options - Options to this query. The default is
(). Options include: "cached" Cache the results of this query in
the list cache. "uncached" Do not cache the results of this query
in the list cache. "score-function=function" Use the selected
scoring function. The score function may be: linearUse a linear
function of the difference between the specified query value and
the matching value in the index to calculate a score for this range
query. reciprocalUse a reciprocal function of the difference
between the specified query value and the matching value in the
index to calculate a score for this range query. zeroThis range
query does not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. (of xs:string)CtsQueryExpr columnRangeQuery(java.lang.String schema, java.lang.String view, java.lang.String column, java.lang.String value, java.lang.String operator, java.lang.String options, double weight)
Provides a client interface to the cts:column-range-query server function.
schema - The TDE schema name. (of xs:string)view - The TDE view name. (of xs:string)column - The TDE column name. (of xs:string)value - One or more values used for querying. (of
xs:anyAtomicType)operator - Operator for the $value values. The
default operator is "=". Operators include: "<" Match range
index values less than $value. "<=" Match range index values
less than or equal to $value. ">" Match range index values
greater than $value. ">=" Match range index values greater than
or equal to $value. "=" Match range index values equal to $value.
"!=" Match range index values not equal to $value. (of xs:string)options - Options to this query. The default is
(). Options include: "cached" Cache the results of this query in
the list cache. "uncached" Do not cache the results of this query
in the list cache. "score-function=function" Use the selected
scoring function. The score function may be: linearUse a linear
function of the difference between the specified query value and
the matching value in the index to calculate a score for this range
query. reciprocalUse a reciprocal function of the difference
between the specified query value and the matching value in the
index to calculate a score for this range query. zeroThis range
query does not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. (of xs:string)weight - A weight for this query. The default is
1.0. (of xs:double)CtsQueryExpr columnRangeQuery(ServerExpression schema, ServerExpression view, ServerExpression column, ServerExpression value, ServerExpression operator, ServerExpression options, ServerExpression weight)
Provides a client interface to the cts:column-range-query server function.
schema - The TDE schema name. (of xs:string)view - The TDE view name. (of xs:string)column - The TDE column name. (of xs:string)value - One or more values used for querying. (of
xs:anyAtomicType)operator - Operator for the $value values. The
default operator is "=". Operators include: "<" Match range
index values less than $value. "<=" Match range index values
less than or equal to $value. ">" Match range index values
greater than $value. ">=" Match range index values greater than
or equal to $value. "=" Match range index values equal to $value.
"!=" Match range index values not equal to $value. (of xs:string)options - Options to this query. The default is
(). Options include: "cached" Cache the results of this query in
the list cache. "uncached" Do not cache the results of this query
in the list cache. "score-function=function" Use the selected
scoring function. The score function may be: linearUse a linear
function of the difference between the specified query value and
the matching value in the index to calculate a score for this range
query. reciprocalUse a reciprocal function of the difference
between the specified query value and the matching value in the
index to calculate a score for this range query. zeroThis range
query does not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. (of xs:string)weight - A weight for this query. The default is
1.0. (of xs:double)CtsPolygonExpr complexPolygon(ServerExpression outer, ServerExpression inner)
Provides a client interface to the cts:complex-polygon server function.
outer - The outer polygon. (of cts:polygon)inner - The inner (hole) polygons. (of cts:polygon)CtsQueryExpr directoryQuery(java.lang.String uris)
Provides a client interface to the cts:directory-query server function.
CtsQueryExpr directoryQuery(ServerExpression uris)
Provides a client interface to the cts:directory-query server function.
CtsQueryExpr directoryQuery(java.lang.String uris, java.lang.String depth)
Provides a client interface to the cts:directory-query server function.
CtsQueryExpr directoryQuery(ServerExpression uris, ServerExpression depth)
Provides a client interface to the cts:directory-query server function.
CtsQueryExpr documentFragmentQuery(ServerExpression query)
Provides a client interface to the cts:document-fragment-query server function.
CtsQueryExpr documentQuery(java.lang.String uris)
Provides a client interface to the cts:document-query server function.
CtsQueryExpr documentQuery(ServerExpression uris)
Provides a client interface to the cts:document-query server function.
CtsQueryExpr elementAttributePairGeospatialQuery(java.lang.String elementName, java.lang.String latitudeName, java.lang.String longitudeName, CtsRegionExpr... region)
Provides a client interface to the cts:element-attribute-pair-geospatial-query server function.
elementName - One or more parent element QNames to
match. When multiple QNames are specified, the query matches if any
QName matches. (of xs:QName)latitudeName - One or more latitude attribute
QNames to match. When multiple QNames are specified, the query
matches if any QName matches; however, only the first matching
latitude attribute in any point instance will be checked. (of
xs:QName)longitudeName - One or more longitude attribute
QNames to match. When multiple QNames are specified, the query
matches if any QName matches; however, only the first matching
longitude attribute in any point instance will be checked. (of
xs:QName)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)CtsQueryExpr elementAttributePairGeospatialQuery(ServerExpression elementName, ServerExpression latitudeName, ServerExpression longitudeName, ServerExpression region)
Provides a client interface to the cts:element-attribute-pair-geospatial-query server function.
elementName - One or more parent element QNames to
match. When multiple QNames are specified, the query matches if any
QName matches. (of xs:QName)latitudeName - One or more latitude attribute
QNames to match. When multiple QNames are specified, the query
matches if any QName matches; however, only the first matching
latitude attribute in any point instance will be checked. (of
xs:QName)longitudeName - One or more longitude attribute
QNames to match. When multiple QNames are specified, the query
matches if any QName matches; however, only the first matching
longitude attribute in any point instance will be checked. (of
xs:QName)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)CtsQueryExpr elementAttributePairGeospatialQuery(java.lang.String elementName, java.lang.String latitudeName, java.lang.String longitudeName, ServerExpression region, java.lang.String... options)
Provides a client interface to the cts:element-attribute-pair-geospatial-query server function.
elementName - One or more parent element QNames to
match. When multiple QNames are specified, the query matches if any
QName matches. (of xs:QName)latitudeName - One or more latitude attribute
QNames to match. When multiple QNames are specified, the query
matches if any QName matches; however, only the first matching
latitude attribute in any point instance will be checked. (of
xs:QName)longitudeName - One or more longitude attribute
QNames to match. When multiple QNames are specified, the query
matches if any QName matches; however, only the first matching
longitude attribute in any point instance will be checked. (of
xs:QName)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)options - Options to this query. The default is
(). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system with degrees as the angular unit. wgs84/radiansThe WGS84
coordinate system with radians as the angular unit. wgs84/doubleThe
WGS84 coordinate system at double precision with degrees as the
angular unit. wgs84/radians/doubleThe WGS84 coordinate system at
double precision with radians as the angular unit. etrs89The ETRS89
coordinate system. etrs89/doubleThe ETRS89 coordinate system at
double precision. rawThe raw (unmapped) coordinate system.
raw/doubleThe raw coordinate system at double precision.
"precision=value" Use the coordinate system at the given precision.
Allowed values: float and double. "units=value" Measure distance
and the radii of circles in the specified units. Allowed values:
miles (default), km, feet, meters. "boundaries-included" Points on
boxes', circles', and polygons' boundaries are counted as matching.
This is the default. "boundaries-excluded" Points on boxes',
circles', and polygons' boundaries are not counted as matching.
"boundaries-latitude-excluded" Points on boxes' latitude boundaries
are not counted as matching. "boundaries-longitude-excluded" Points
on boxes' longitude boundaries are not counted as matching.
"boundaries-south-excluded" Points on the boxes' southern
boundaries are not counted as matching. "boundaries-west-excluded"
Points on the boxes' western boundaries are not counted as
matching. "boundaries-north-excluded" Points on the boxes' northern
boundaries are not counted as matching. "boundaries-east-excluded"
Points on the boxes' eastern boundaries are not counted as
matching. "boundaries-circle-excluded" Points on circles' boundary
are not counted as matching. "boundaries-endpoints-excluded" Points
on linestrings' boundary (the endpoints) are not counted as
matching. "cached" Cache the results of this query in the list
cache. "uncached" Do not cache the results of this query in the
list cache. "score-function=function" Use the selected scoring
function. The score function may be: linearUse a linear function of
the difference between the specified query value and the matching
value in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $regions parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrence of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)CtsQueryExpr elementAttributePairGeospatialQuery(ServerExpression elementName, ServerExpression latitudeName, ServerExpression longitudeName, ServerExpression region, ServerExpression options)
Provides a client interface to the cts:element-attribute-pair-geospatial-query server function.
elementName - One or more parent element QNames to
match. When multiple QNames are specified, the query matches if any
QName matches. (of xs:QName)latitudeName - One or more latitude attribute
QNames to match. When multiple QNames are specified, the query
matches if any QName matches; however, only the first matching
latitude attribute in any point instance will be checked. (of
xs:QName)longitudeName - One or more longitude attribute
QNames to match. When multiple QNames are specified, the query
matches if any QName matches; however, only the first matching
longitude attribute in any point instance will be checked. (of
xs:QName)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)options - Options to this query. The default is
(). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system with degrees as the angular unit. wgs84/radiansThe WGS84
coordinate system with radians as the angular unit. wgs84/doubleThe
WGS84 coordinate system at double precision with degrees as the
angular unit. wgs84/radians/doubleThe WGS84 coordinate system at
double precision with radians as the angular unit. etrs89The ETRS89
coordinate system. etrs89/doubleThe ETRS89 coordinate system at
double precision. rawThe raw (unmapped) coordinate system.
raw/doubleThe raw coordinate system at double precision.
"precision=value" Use the coordinate system at the given precision.
Allowed values: float and double. "units=value" Measure distance
and the radii of circles in the specified units. Allowed values:
miles (default), km, feet, meters. "boundaries-included" Points on
boxes', circles', and polygons' boundaries are counted as matching.
This is the default. "boundaries-excluded" Points on boxes',
circles', and polygons' boundaries are not counted as matching.
"boundaries-latitude-excluded" Points on boxes' latitude boundaries
are not counted as matching. "boundaries-longitude-excluded" Points
on boxes' longitude boundaries are not counted as matching.
"boundaries-south-excluded" Points on the boxes' southern
boundaries are not counted as matching. "boundaries-west-excluded"
Points on the boxes' western boundaries are not counted as
matching. "boundaries-north-excluded" Points on the boxes' northern
boundaries are not counted as matching. "boundaries-east-excluded"
Points on the boxes' eastern boundaries are not counted as
matching. "boundaries-circle-excluded" Points on circles' boundary
are not counted as matching. "boundaries-endpoints-excluded" Points
on linestrings' boundary (the endpoints) are not counted as
matching. "cached" Cache the results of this query in the list
cache. "uncached" Do not cache the results of this query in the
list cache. "score-function=function" Use the selected scoring
function. The score function may be: linearUse a linear function of
the difference between the specified query value and the matching
value in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $regions parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrence of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)CtsQueryExpr elementAttributePairGeospatialQuery(java.lang.String elementName, java.lang.String latitudeName, java.lang.String longitudeName, ServerExpression region, java.lang.String options, double weight)
Provides a client interface to the cts:element-attribute-pair-geospatial-query server function.
elementName - One or more parent element QNames to
match. When multiple QNames are specified, the query matches if any
QName matches. (of xs:QName)latitudeName - One or more latitude attribute
QNames to match. When multiple QNames are specified, the query
matches if any QName matches; however, only the first matching
latitude attribute in any point instance will be checked. (of
xs:QName)longitudeName - One or more longitude attribute
QNames to match. When multiple QNames are specified, the query
matches if any QName matches; however, only the first matching
longitude attribute in any point instance will be checked. (of
xs:QName)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)options - Options to this query. The default is
(). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system with degrees as the angular unit. wgs84/radiansThe WGS84
coordinate system with radians as the angular unit. wgs84/doubleThe
WGS84 coordinate system at double precision with degrees as the
angular unit. wgs84/radians/doubleThe WGS84 coordinate system at
double precision with radians as the angular unit. etrs89The ETRS89
coordinate system. etrs89/doubleThe ETRS89 coordinate system at
double precision. rawThe raw (unmapped) coordinate system.
raw/doubleThe raw coordinate system at double precision.
"precision=value" Use the coordinate system at the given precision.
Allowed values: float and double. "units=value" Measure distance
and the radii of circles in the specified units. Allowed values:
miles (default), km, feet, meters. "boundaries-included" Points on
boxes', circles', and polygons' boundaries are counted as matching.
This is the default. "boundaries-excluded" Points on boxes',
circles', and polygons' boundaries are not counted as matching.
"boundaries-latitude-excluded" Points on boxes' latitude boundaries
are not counted as matching. "boundaries-longitude-excluded" Points
on boxes' longitude boundaries are not counted as matching.
"boundaries-south-excluded" Points on the boxes' southern
boundaries are not counted as matching. "boundaries-west-excluded"
Points on the boxes' western boundaries are not counted as
matching. "boundaries-north-excluded" Points on the boxes' northern
boundaries are not counted as matching. "boundaries-east-excluded"
Points on the boxes' eastern boundaries are not counted as
matching. "boundaries-circle-excluded" Points on circles' boundary
are not counted as matching. "boundaries-endpoints-excluded" Points
on linestrings' boundary (the endpoints) are not counted as
matching. "cached" Cache the results of this query in the list
cache. "uncached" Do not cache the results of this query in the
list cache. "score-function=function" Use the selected scoring
function. The score function may be: linearUse a linear function of
the difference between the specified query value and the matching
value in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $regions parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrence of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)weight - A weight for this query. The default is
1.0. (of xs:double)CtsQueryExpr elementAttributePairGeospatialQuery(ServerExpression elementName, ServerExpression latitudeName, ServerExpression longitudeName, ServerExpression region, ServerExpression options, ServerExpression weight)
Provides a client interface to the cts:element-attribute-pair-geospatial-query server function.
elementName - One or more parent element QNames to
match. When multiple QNames are specified, the query matches if any
QName matches. (of xs:QName)latitudeName - One or more latitude attribute
QNames to match. When multiple QNames are specified, the query
matches if any QName matches; however, only the first matching
latitude attribute in any point instance will be checked. (of
xs:QName)longitudeName - One or more longitude attribute
QNames to match. When multiple QNames are specified, the query
matches if any QName matches; however, only the first matching
longitude attribute in any point instance will be checked. (of
xs:QName)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)options - Options to this query. The default is
(). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system with degrees as the angular unit. wgs84/radiansThe WGS84
coordinate system with radians as the angular unit. wgs84/doubleThe
WGS84 coordinate system at double precision with degrees as the
angular unit. wgs84/radians/doubleThe WGS84 coordinate system at
double precision with radians as the angular unit. etrs89The ETRS89
coordinate system. etrs89/doubleThe ETRS89 coordinate system at
double precision. rawThe raw (unmapped) coordinate system.
raw/doubleThe raw coordinate system at double precision.
"precision=value" Use the coordinate system at the given precision.
Allowed values: float and double. "units=value" Measure distance
and the radii of circles in the specified units. Allowed values:
miles (default), km, feet, meters. "boundaries-included" Points on
boxes', circles', and polygons' boundaries are counted as matching.
This is the default. "boundaries-excluded" Points on boxes',
circles', and polygons' boundaries are not counted as matching.
"boundaries-latitude-excluded" Points on boxes' latitude boundaries
are not counted as matching. "boundaries-longitude-excluded" Points
on boxes' longitude boundaries are not counted as matching.
"boundaries-south-excluded" Points on the boxes' southern
boundaries are not counted as matching. "boundaries-west-excluded"
Points on the boxes' western boundaries are not counted as
matching. "boundaries-north-excluded" Points on the boxes' northern
boundaries are not counted as matching. "boundaries-east-excluded"
Points on the boxes' eastern boundaries are not counted as
matching. "boundaries-circle-excluded" Points on circles' boundary
are not counted as matching. "boundaries-endpoints-excluded" Points
on linestrings' boundary (the endpoints) are not counted as
matching. "cached" Cache the results of this query in the list
cache. "uncached" Do not cache the results of this query in the
list cache. "score-function=function" Use the selected scoring
function. The score function may be: linearUse a linear function of
the difference between the specified query value and the matching
value in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $regions parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrence of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)weight - A weight for this query. The default is
1.0. (of xs:double)CtsQueryExpr elementAttributeRangeQuery(java.lang.String elementName, java.lang.String attributeName, java.lang.String operator, java.lang.String value)
Provides a client interface to the cts:element-attribute-range-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)attributeName - One or more attribute QNames to
match. When multiple QNames are specified, the query matches if any
QName matches. (of xs:QName)operator - A comparison operator. Operators
include: "<" Match range index values less than $value. "<="
Match range index values less than or equal to $value. ">" Match
range index values greater than $value. ">=" Match range index
values greater than or equal to $value. "=" Match range index
values equal to $value. "!=" Match range index values not equal to
$value. (of xs:string)value - Some values to match. When multiple values
are specified, the query matches if any value matches. (of xs:anyAtomicType)CtsQueryExpr elementAttributeRangeQuery(ServerExpression elementName, ServerExpression attributeName, ServerExpression operator, ServerExpression value)
Provides a client interface to the cts:element-attribute-range-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)attributeName - One or more attribute QNames to
match. When multiple QNames are specified, the query matches if any
QName matches. (of xs:QName)operator - A comparison operator. Operators
include: "<" Match range index values less than $value. "<="
Match range index values less than or equal to $value. ">" Match
range index values greater than $value. ">=" Match range index
values greater than or equal to $value. "=" Match range index
values equal to $value. "!=" Match range index values not equal to
$value. (of xs:string)value - Some values to match. When multiple values
are specified, the query matches if any value matches. (of xs:anyAtomicType)CtsQueryExpr elementAttributeRangeQuery(java.lang.String elementName, java.lang.String attributeName, java.lang.String operator, java.lang.String value, java.lang.String... options)
Provides a client interface to the cts:element-attribute-range-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)attributeName - One or more attribute QNames to
match. When multiple QNames are specified, the query matches if any
QName matches. (of xs:QName)operator - A comparison operator. Operators
include: "<" Match range index values less than $value. "<="
Match range index values less than or equal to $value. ">" Match
range index values greater than $value. ">=" Match range index
values greater than or equal to $value. "=" Match range index
values equal to $value. "!=" Match range index values not equal to
$value. (of xs:string)value - Some values to match. When multiple values
are specified, the query matches if any value matches. (of xs:anyAtomicType)options - Options to this query. The default is
(). Options include: "collation=URI" Use the range index with the
collation specified by URI. If not specified, then the default
collation from the query is used. If a range index with the
specified collation does not exist, an error is thrown. "cached"
Cache the results of this query in the list cache. "uncached" Do
not cache the results of this query in the list cache.
"cached-incremental" When querying on a short date or dateTime
range, break the query into sub-queries on smaller ranges, and then
cache the results of each. See the Usage Notes for details.
"min-occurs=number" Specifies the minimum number of occurrences
required. If fewer that this number of words occur, the fragment
does not match. The default is 1. "max-occurs=number" Specifies the
maximum number of occurrences required. If more than this number of
words occur, the fragment does not match. The default is unbounded.
"score-function=function" Use the selected scoring function. The
score function may be: linearUse a linear function of the
difference between the specified query value and the matching value
in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $value parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrences of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)CtsQueryExpr elementAttributeRangeQuery(ServerExpression elementName, ServerExpression attributeName, ServerExpression operator, ServerExpression value, ServerExpression options)
Provides a client interface to the cts:element-attribute-range-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)attributeName - One or more attribute QNames to
match. When multiple QNames are specified, the query matches if any
QName matches. (of xs:QName)operator - A comparison operator. Operators
include: "<" Match range index values less than $value. "<="
Match range index values less than or equal to $value. ">" Match
range index values greater than $value. ">=" Match range index
values greater than or equal to $value. "=" Match range index
values equal to $value. "!=" Match range index values not equal to
$value. (of xs:string)value - Some values to match. When multiple values
are specified, the query matches if any value matches. (of xs:anyAtomicType)options - Options to this query. The default is
(). Options include: "collation=URI" Use the range index with the
collation specified by URI. If not specified, then the default
collation from the query is used. If a range index with the
specified collation does not exist, an error is thrown. "cached"
Cache the results of this query in the list cache. "uncached" Do
not cache the results of this query in the list cache.
"cached-incremental" When querying on a short date or dateTime
range, break the query into sub-queries on smaller ranges, and then
cache the results of each. See the Usage Notes for details.
"min-occurs=number" Specifies the minimum number of occurrences
required. If fewer that this number of words occur, the fragment
does not match. The default is 1. "max-occurs=number" Specifies the
maximum number of occurrences required. If more than this number of
words occur, the fragment does not match. The default is unbounded.
"score-function=function" Use the selected scoring function. The
score function may be: linearUse a linear function of the
difference between the specified query value and the matching value
in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $value parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrences of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)CtsQueryExpr elementAttributeRangeQuery(java.lang.String elementName, java.lang.String attributeName, java.lang.String operator, java.lang.String value, java.lang.String options, double weight)
Provides a client interface to the cts:element-attribute-range-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)attributeName - One or more attribute QNames to
match. When multiple QNames are specified, the query matches if any
QName matches. (of xs:QName)operator - A comparison operator. Operators
include: "<" Match range index values less than $value. "<="
Match range index values less than or equal to $value. ">" Match
range index values greater than $value. ">=" Match range index
values greater than or equal to $value. "=" Match range index
values equal to $value. "!=" Match range index values not equal to
$value. (of xs:string)value - Some values to match. When multiple values
are specified, the query matches if any value matches. (of xs:anyAtomicType)options - Options to this query. The default is
(). Options include: "collation=URI" Use the range index with the
collation specified by URI. If not specified, then the default
collation from the query is used. If a range index with the
specified collation does not exist, an error is thrown. "cached"
Cache the results of this query in the list cache. "uncached" Do
not cache the results of this query in the list cache.
"cached-incremental" When querying on a short date or dateTime
range, break the query into sub-queries on smaller ranges, and then
cache the results of each. See the Usage Notes for details.
"min-occurs=number" Specifies the minimum number of occurrences
required. If fewer that this number of words occur, the fragment
does not match. The default is 1. "max-occurs=number" Specifies the
maximum number of occurrences required. If more than this number of
words occur, the fragment does not match. The default is unbounded.
"score-function=function" Use the selected scoring function. The
score function may be: linearUse a linear function of the
difference between the specified query value and the matching value
in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $value parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrences of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)weight - A weight for this query. The default is
1.0. (of xs:double)CtsQueryExpr elementAttributeRangeQuery(ServerExpression elementName, ServerExpression attributeName, ServerExpression operator, ServerExpression value, ServerExpression options, ServerExpression weight)
Provides a client interface to the cts:element-attribute-range-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)attributeName - One or more attribute QNames to
match. When multiple QNames are specified, the query matches if any
QName matches. (of xs:QName)operator - A comparison operator. Operators
include: "<" Match range index values less than $value. "<="
Match range index values less than or equal to $value. ">" Match
range index values greater than $value. ">=" Match range index
values greater than or equal to $value. "=" Match range index
values equal to $value. "!=" Match range index values not equal to
$value. (of xs:string)value - Some values to match. When multiple values
are specified, the query matches if any value matches. (of xs:anyAtomicType)options - Options to this query. The default is
(). Options include: "collation=URI" Use the range index with the
collation specified by URI. If not specified, then the default
collation from the query is used. If a range index with the
specified collation does not exist, an error is thrown. "cached"
Cache the results of this query in the list cache. "uncached" Do
not cache the results of this query in the list cache.
"cached-incremental" When querying on a short date or dateTime
range, break the query into sub-queries on smaller ranges, and then
cache the results of each. See the Usage Notes for details.
"min-occurs=number" Specifies the minimum number of occurrences
required. If fewer that this number of words occur, the fragment
does not match. The default is 1. "max-occurs=number" Specifies the
maximum number of occurrences required. If more than this number of
words occur, the fragment does not match. The default is unbounded.
"score-function=function" Use the selected scoring function. The
score function may be: linearUse a linear function of the
difference between the specified query value and the matching value
in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $value parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrences of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)weight - A weight for this query. The default is
1.0. (of xs:double)CtsReferenceExpr elementAttributeReference(java.lang.String element, java.lang.String attribute)
Provides a client interface to the cts:element-attribute-reference server function.
element - An element QName. (of xs:QName)attribute - An attribute QName. (of xs:QName)CtsReferenceExpr elementAttributeReference(ServerExpression element, ServerExpression attribute)
Provides a client interface to the cts:element-attribute-reference server function.
element - An element QName. (of xs:QName)attribute - An attribute QName. (of xs:QName)CtsReferenceExpr elementAttributeReference(java.lang.String element, java.lang.String attribute, java.lang.String options)
Provides a client interface to the cts:element-attribute-reference server function.
element - An element QName. (of xs:QName)attribute - An attribute QName. (of xs:QName)options - Options. The default is (). Options
include: "type=type" Use the lexicon with the type specified by
type (int, unsignedInt, long, unsignedLong, float, double, decimal,
dateTime, time, date, gYearMonth, gYear, gMonth, gDay,
yearMonthDuration, dayTimeDuration, string, anyURI, point, or
long-lat-point) "collation=URI" Use the lexicon with the collation
specified by URI. "nullable" Allow null values in tuples reported
from cts:value-tuples when using this lexicon. "unchecked" Read the
scalar type, collation and coordinate-system info only from the
input. Do not check the definition against the context database.
"coordinate-system=name" Create a reference to an index or lexicon
based on the specified coordinate system. Allowed values: "wgs84",
"wgs84/double", "raw", "raw/double". Only applicable if the
index/lexicon value type is point or long-lat-point.
"precision=value" Create a reference to an index or lexicon
configured with the specified geospatial precision. Allowed values:
float and double. Only applicable if the index/lexicon value type
is point or long-lat-point. This value takes precedence over the
precision implicit in the coordinate system name. (of xs:string)CtsReferenceExpr elementAttributeReference(ServerExpression element, ServerExpression attribute, ServerExpression options)
Provides a client interface to the cts:element-attribute-reference server function.
element - An element QName. (of xs:QName)attribute - An attribute QName. (of xs:QName)options - Options. The default is (). Options
include: "type=type" Use the lexicon with the type specified by
type (int, unsignedInt, long, unsignedLong, float, double, decimal,
dateTime, time, date, gYearMonth, gYear, gMonth, gDay,
yearMonthDuration, dayTimeDuration, string, anyURI, point, or
long-lat-point) "collation=URI" Use the lexicon with the collation
specified by URI. "nullable" Allow null values in tuples reported
from cts:value-tuples when using this lexicon. "unchecked" Read the
scalar type, collation and coordinate-system info only from the
input. Do not check the definition against the context database.
"coordinate-system=name" Create a reference to an index or lexicon
based on the specified coordinate system. Allowed values: "wgs84",
"wgs84/double", "raw", "raw/double". Only applicable if the
index/lexicon value type is point or long-lat-point.
"precision=value" Create a reference to an index or lexicon
configured with the specified geospatial precision. Allowed values:
float and double. Only applicable if the index/lexicon value type
is point or long-lat-point. This value takes precedence over the
precision implicit in the coordinate system name. (of xs:string)CtsQueryExpr elementAttributeValueQuery(java.lang.String elementName, java.lang.String attributeName, java.lang.String text)
Provides a client interface to the cts:element-attribute-value-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)attributeName - One or more attribute QNames to
match. When multiple QNames are specified, the query matches if any
QName matches. (of xs:QName)text - One or more attribute values to match. When
multiple strings are specified, the query matches if any string
matches. (of xs:string)CtsQueryExpr elementAttributeValueQuery(ServerExpression elementName, ServerExpression attributeName, ServerExpression text)
Provides a client interface to the cts:element-attribute-value-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)attributeName - One or more attribute QNames to
match. When multiple QNames are specified, the query matches if any
QName matches. (of xs:QName)text - One or more attribute values to match. When
multiple strings are specified, the query matches if any string
matches. (of xs:string)CtsQueryExpr elementAttributeValueQuery(java.lang.String elementName, java.lang.String attributeName, java.lang.String text, java.lang.String... options)
Provides a client interface to the cts:element-attribute-value-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)attributeName - One or more attribute QNames to
match. When multiple QNames are specified, the query matches if any
QName matches. (of xs:QName)text - One or more attribute values to match. When
multiple strings are specified, the query matches if any string
matches. (of xs:string)options - Options to this query. The default is
(). Options include: "case-sensitive" A case-sensitive query.
"case-insensitive" A case-insensitive query. "diacritic-sensitive"
A diacritic-sensitive query. "diacritic-insensitive" A
diacritic-insensitive query. "punctuation-sensitive" A
punctuation-sensitive query. "punctuation-insensitive" A
punctuation-insensitive query. "whitespace-sensitive" A
whitespace-sensitive query. "whitespace-insensitive" A
whitespace-insensitive query. "stemmed" A stemmed query.
"unstemmed" An unstemmed query. "wildcarded" A wildcarded query.
"unwildcarded" An unwildcarded query. "exact" An exact match query.
Shorthand for "case-sensitive", "diacritic-sensitive",
"punctuation-sensitive", "whitespace-sensitive", "unstemmed", and
"unwildcarded". "lang=iso639code" Specifies the language of the
query. The iso639code code portion is case-insensitive, and uses
the languages specified by ISO 639. The default is specified in the
database configuration. "min-occurs=number" Specifies the minimum
number of occurrences required. If fewer that this number of words
occur, the fragment does not match. The default is 1.
"max-occurs=number" Specifies the maximum number of occurrences
required. If more than this number of words occur, the fragment
does not match. The default is unbounded. "synonym" Specifies that
all of the terms in the $text parameter are considered synonyms for
scoring purposes. The result is that occurrences of more than one
of the synonyms are scored as if there are more occurrences of the
same term (as opposed to having a separate term that contributes to
score). * "lexicon-expansion-limit=number" Specifies the limit for
lexicon expansion. This puts a restriction on the number of lexicon
expansions that can be performed. If the limit is exceeded, the
server may raise an error depending on whether the "limit-check"
option is set. The default value for this option will be 4096.
"limit-check" Specifies that an error will be raised if the lexicon
expansion exceeds the specified limit. "no-limit-check" Specifies
that error will not be raised if the lexicon expansion exceeds the
specified limit. The server will try to resolve the wildcard. (of
xs:string)CtsQueryExpr elementAttributeValueQuery(ServerExpression elementName, ServerExpression attributeName, ServerExpression text, ServerExpression options)
Provides a client interface to the cts:element-attribute-value-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)attributeName - One or more attribute QNames to
match. When multiple QNames are specified, the query matches if any
QName matches. (of xs:QName)text - One or more attribute values to match. When
multiple strings are specified, the query matches if any string
matches. (of xs:string)options - Options to this query. The default is
(). Options include: "case-sensitive" A case-sensitive query.
"case-insensitive" A case-insensitive query. "diacritic-sensitive"
A diacritic-sensitive query. "diacritic-insensitive" A
diacritic-insensitive query. "punctuation-sensitive" A
punctuation-sensitive query. "punctuation-insensitive" A
punctuation-insensitive query. "whitespace-sensitive" A
whitespace-sensitive query. "whitespace-insensitive" A
whitespace-insensitive query. "stemmed" A stemmed query.
"unstemmed" An unstemmed query. "wildcarded" A wildcarded query.
"unwildcarded" An unwildcarded query. "exact" An exact match query.
Shorthand for "case-sensitive", "diacritic-sensitive",
"punctuation-sensitive", "whitespace-sensitive", "unstemmed", and
"unwildcarded". "lang=iso639code" Specifies the language of the
query. The iso639code code portion is case-insensitive, and uses
the languages specified by ISO 639. The default is specified in the
database configuration. "min-occurs=number" Specifies the minimum
number of occurrences required. If fewer that this number of words
occur, the fragment does not match. The default is 1.
"max-occurs=number" Specifies the maximum number of occurrences
required. If more than this number of words occur, the fragment
does not match. The default is unbounded. "synonym" Specifies that
all of the terms in the $text parameter are considered synonyms for
scoring purposes. The result is that occurrences of more than one
of the synonyms are scored as if there are more occurrences of the
same term (as opposed to having a separate term that contributes to
score). * "lexicon-expansion-limit=number" Specifies the limit for
lexicon expansion. This puts a restriction on the number of lexicon
expansions that can be performed. If the limit is exceeded, the
server may raise an error depending on whether the "limit-check"
option is set. The default value for this option will be 4096.
"limit-check" Specifies that an error will be raised if the lexicon
expansion exceeds the specified limit. "no-limit-check" Specifies
that error will not be raised if the lexicon expansion exceeds the
specified limit. The server will try to resolve the wildcard. (of
xs:string)CtsQueryExpr elementAttributeValueQuery(java.lang.String elementName, java.lang.String attributeName, java.lang.String text, java.lang.String options, double weight)
Provides a client interface to the cts:element-attribute-value-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)attributeName - One or more attribute QNames to
match. When multiple QNames are specified, the query matches if any
QName matches. (of xs:QName)text - One or more attribute values to match. When
multiple strings are specified, the query matches if any string
matches. (of xs:string)options - Options to this query. The default is
(). Options include: "case-sensitive" A case-sensitive query.
"case-insensitive" A case-insensitive query. "diacritic-sensitive"
A diacritic-sensitive query. "diacritic-insensitive" A
diacritic-insensitive query. "punctuation-sensitive" A
punctuation-sensitive query. "punctuation-insensitive" A
punctuation-insensitive query. "whitespace-sensitive" A
whitespace-sensitive query. "whitespace-insensitive" A
whitespace-insensitive query. "stemmed" A stemmed query.
"unstemmed" An unstemmed query. "wildcarded" A wildcarded query.
"unwildcarded" An unwildcarded query. "exact" An exact match query.
Shorthand for "case-sensitive", "diacritic-sensitive",
"punctuation-sensitive", "whitespace-sensitive", "unstemmed", and
"unwildcarded". "lang=iso639code" Specifies the language of the
query. The iso639code code portion is case-insensitive, and uses
the languages specified by ISO 639. The default is specified in the
database configuration. "min-occurs=number" Specifies the minimum
number of occurrences required. If fewer that this number of words
occur, the fragment does not match. The default is 1.
"max-occurs=number" Specifies the maximum number of occurrences
required. If more than this number of words occur, the fragment
does not match. The default is unbounded. "synonym" Specifies that
all of the terms in the $text parameter are considered synonyms for
scoring purposes. The result is that occurrences of more than one
of the synonyms are scored as if there are more occurrences of the
same term (as opposed to having a separate term that contributes to
score). * "lexicon-expansion-limit=number" Specifies the limit for
lexicon expansion. This puts a restriction on the number of lexicon
expansions that can be performed. If the limit is exceeded, the
server may raise an error depending on whether the "limit-check"
option is set. The default value for this option will be 4096.
"limit-check" Specifies that an error will be raised if the lexicon
expansion exceeds the specified limit. "no-limit-check" Specifies
that error will not be raised if the lexicon expansion exceeds the
specified limit. The server will try to resolve the wildcard. (of
xs:string)weight - A weight for this query. Higher weights
move search results up in the relevance order. The default is 1.0.
The weight should be between 64 and -16. Weights greater than 64
will have the same effect as a weight of 64. Weights less than the
absolute value of 0.0625 (between -0.0625 and 0.0625) are rounded
to 0, which means that they do not contribute to the score. (of
xs:double)CtsQueryExpr elementAttributeValueQuery(ServerExpression elementName, ServerExpression attributeName, ServerExpression text, ServerExpression options, ServerExpression weight)
Provides a client interface to the cts:element-attribute-value-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)attributeName - One or more attribute QNames to
match. When multiple QNames are specified, the query matches if any
QName matches. (of xs:QName)text - One or more attribute values to match. When
multiple strings are specified, the query matches if any string
matches. (of xs:string)options - Options to this query. The default is
(). Options include: "case-sensitive" A case-sensitive query.
"case-insensitive" A case-insensitive query. "diacritic-sensitive"
A diacritic-sensitive query. "diacritic-insensitive" A
diacritic-insensitive query. "punctuation-sensitive" A
punctuation-sensitive query. "punctuation-insensitive" A
punctuation-insensitive query. "whitespace-sensitive" A
whitespace-sensitive query. "whitespace-insensitive" A
whitespace-insensitive query. "stemmed" A stemmed query.
"unstemmed" An unstemmed query. "wildcarded" A wildcarded query.
"unwildcarded" An unwildcarded query. "exact" An exact match query.
Shorthand for "case-sensitive", "diacritic-sensitive",
"punctuation-sensitive", "whitespace-sensitive", "unstemmed", and
"unwildcarded". "lang=iso639code" Specifies the language of the
query. The iso639code code portion is case-insensitive, and uses
the languages specified by ISO 639. The default is specified in the
database configuration. "min-occurs=number" Specifies the minimum
number of occurrences required. If fewer that this number of words
occur, the fragment does not match. The default is 1.
"max-occurs=number" Specifies the maximum number of occurrences
required. If more than this number of words occur, the fragment
does not match. The default is unbounded. "synonym" Specifies that
all of the terms in the $text parameter are considered synonyms for
scoring purposes. The result is that occurrences of more than one
of the synonyms are scored as if there are more occurrences of the
same term (as opposed to having a separate term that contributes to
score). * "lexicon-expansion-limit=number" Specifies the limit for
lexicon expansion. This puts a restriction on the number of lexicon
expansions that can be performed. If the limit is exceeded, the
server may raise an error depending on whether the "limit-check"
option is set. The default value for this option will be 4096.
"limit-check" Specifies that an error will be raised if the lexicon
expansion exceeds the specified limit. "no-limit-check" Specifies
that error will not be raised if the lexicon expansion exceeds the
specified limit. The server will try to resolve the wildcard. (of
xs:string)weight - A weight for this query. Higher weights
move search results up in the relevance order. The default is 1.0.
The weight should be between 64 and -16. Weights greater than 64
will have the same effect as a weight of 64. Weights less than the
absolute value of 0.0625 (between -0.0625 and 0.0625) are rounded
to 0, which means that they do not contribute to the score. (of
xs:double)CtsQueryExpr elementAttributeWordQuery(java.lang.String elementName, java.lang.String attributeName, java.lang.String text)
Provides a client interface to the cts:element-attribute-word-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)attributeName - One or more attribute QNames to
match. When multiple QNames are specified, the query matches if any
QName matches. (of xs:QName)text - Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches. (of xs:string)CtsQueryExpr elementAttributeWordQuery(ServerExpression elementName, ServerExpression attributeName, ServerExpression text)
Provides a client interface to the cts:element-attribute-word-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)attributeName - One or more attribute QNames to
match. When multiple QNames are specified, the query matches if any
QName matches. (of xs:QName)text - Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches. (of xs:string)CtsQueryExpr elementAttributeWordQuery(java.lang.String elementName, java.lang.String attributeName, java.lang.String text, java.lang.String... options)
Provides a client interface to the cts:element-attribute-word-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)attributeName - One or more attribute QNames to
match. When multiple QNames are specified, the query matches if any
QName matches. (of xs:QName)text - Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches. (of xs:string)options - Options to this query. The default is
(). Options include: "case-sensitive" A case-sensitive query.
"case-insensitive" A case-insensitive query. "diacritic-sensitive"
A diacritic-sensitive query. "diacritic-insensitive" A
diacritic-insensitive query. "punctuation-sensitive" A
punctuation-sensitive query. "punctuation-insensitive" A
punctuation-insensitive query. "whitespace-sensitive" A
whitespace-sensitive query. "whitespace-insensitive" A
whitespace-insensitive query. "stemmed" A stemmed query.
"unstemmed" An unstemmed query. "wildcarded" A wildcarded query.
"unwildcarded" An unwildcarded query. "exact" An exact match query.
Shorthand for "case-sensitive", "diacritic-sensitive",
"punctuation-sensitive", "whitespace-sensitive", "unstemmed", and
"unwildcarded". "lang=iso639code" Specifies the language of the
query. The iso639code code portion is case-insensitive, and uses
the languages specified by ISO 639. The default is specified in the
database configuration. "min-occurs=number" Specifies the minimum
number of occurrences required. If fewer that this number of words
occur, the fragment does not match. The default is 1.
"max-occurs=number" Specifies the maximum number of occurrences
required. If more than this number of words occur, the fragment
does not match. The default is unbounded. "synonym" Specifies that
all of the terms in the $text parameter are considered synonyms for
scoring purposes. The result is that occurrences of more than one
of the synonyms are scored as if there are more occurrences of the
same term (as opposed to having a separate term that contributes to
score). "lexicon-expand=value" The value is one of full,
prefix-postfix, off, or heuristic (the default is heuristic). An
option with a value of lexicon-expand=full specifies that wildcards
are resolved by expanding the pattern to words in a lexicon (if
there is one available), and turning into a series of
cts:word-queries, even if this takes a long time to evaluate. An
option with a value of lexicon-expand=prefix-postfix specifies that
wildcards are resolved by expanding the pattern to the pre- and
postfixes of the words in the word lexicon (if there is one), and
turning the query into a series of character queries, even if it
takes a long time to evaluate. An option with a value of
lexicon-expand=off specifies that wildcards are only resolved by
looking up character patterns in the search pattern index, not in
the lexicon. An option with a value of lexicon-expand=heuristic,
which is the default, specifies that wildcards are resolved by
using a series of internal rules, such as estimating the number of
lexicon entries that need to be scanned, seeing if the estimate
crosses certain thresholds, and (if appropriate), using another way
besides lexicon expansion to resolve the query. *
"lexicon-expansion-limit=number" Specifies the limit for lexicon
expansion. This puts a restriction on the number of lexicon
expansions that can be performed. If the limit is exceeded, the
server may raise an error depending on whether the "limit-check"
option is set. The default value for this option will be 4096.
"limit-check" Specifies that an error will be raised if the lexicon
expansion exceeds the specified limit. "no-limit-check" Specifies
that error will not be raised if the lexicon expansion exceeds the
specified limit. The server will try to resolve the wildcard. (of
xs:string)CtsQueryExpr elementAttributeWordQuery(ServerExpression elementName, ServerExpression attributeName, ServerExpression text, ServerExpression options)
Provides a client interface to the cts:element-attribute-word-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)attributeName - One or more attribute QNames to
match. When multiple QNames are specified, the query matches if any
QName matches. (of xs:QName)text - Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches. (of xs:string)options - Options to this query. The default is
(). Options include: "case-sensitive" A case-sensitive query.
"case-insensitive" A case-insensitive query. "diacritic-sensitive"
A diacritic-sensitive query. "diacritic-insensitive" A
diacritic-insensitive query. "punctuation-sensitive" A
punctuation-sensitive query. "punctuation-insensitive" A
punctuation-insensitive query. "whitespace-sensitive" A
whitespace-sensitive query. "whitespace-insensitive" A
whitespace-insensitive query. "stemmed" A stemmed query.
"unstemmed" An unstemmed query. "wildcarded" A wildcarded query.
"unwildcarded" An unwildcarded query. "exact" An exact match query.
Shorthand for "case-sensitive", "diacritic-sensitive",
"punctuation-sensitive", "whitespace-sensitive", "unstemmed", and
"unwildcarded". "lang=iso639code" Specifies the language of the
query. The iso639code code portion is case-insensitive, and uses
the languages specified by ISO 639. The default is specified in the
database configuration. "min-occurs=number" Specifies the minimum
number of occurrences required. If fewer that this number of words
occur, the fragment does not match. The default is 1.
"max-occurs=number" Specifies the maximum number of occurrences
required. If more than this number of words occur, the fragment
does not match. The default is unbounded. "synonym" Specifies that
all of the terms in the $text parameter are considered synonyms for
scoring purposes. The result is that occurrences of more than one
of the synonyms are scored as if there are more occurrences of the
same term (as opposed to having a separate term that contributes to
score). "lexicon-expand=value" The value is one of full,
prefix-postfix, off, or heuristic (the default is heuristic). An
option with a value of lexicon-expand=full specifies that wildcards
are resolved by expanding the pattern to words in a lexicon (if
there is one available), and turning into a series of
cts:word-queries, even if this takes a long time to evaluate. An
option with a value of lexicon-expand=prefix-postfix specifies that
wildcards are resolved by expanding the pattern to the pre- and
postfixes of the words in the word lexicon (if there is one), and
turning the query into a series of character queries, even if it
takes a long time to evaluate. An option with a value of
lexicon-expand=off specifies that wildcards are only resolved by
looking up character patterns in the search pattern index, not in
the lexicon. An option with a value of lexicon-expand=heuristic,
which is the default, specifies that wildcards are resolved by
using a series of internal rules, such as estimating the number of
lexicon entries that need to be scanned, seeing if the estimate
crosses certain thresholds, and (if appropriate), using another way
besides lexicon expansion to resolve the query. *
"lexicon-expansion-limit=number" Specifies the limit for lexicon
expansion. This puts a restriction on the number of lexicon
expansions that can be performed. If the limit is exceeded, the
server may raise an error depending on whether the "limit-check"
option is set. The default value for this option will be 4096.
"limit-check" Specifies that an error will be raised if the lexicon
expansion exceeds the specified limit. "no-limit-check" Specifies
that error will not be raised if the lexicon expansion exceeds the
specified limit. The server will try to resolve the wildcard. (of
xs:string)CtsQueryExpr elementAttributeWordQuery(java.lang.String elementName, java.lang.String attributeName, java.lang.String text, java.lang.String options, double weight)
Provides a client interface to the cts:element-attribute-word-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)attributeName - One or more attribute QNames to
match. When multiple QNames are specified, the query matches if any
QName matches. (of xs:QName)text - Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches. (of xs:string)options - Options to this query. The default is
(). Options include: "case-sensitive" A case-sensitive query.
"case-insensitive" A case-insensitive query. "diacritic-sensitive"
A diacritic-sensitive query. "diacritic-insensitive" A
diacritic-insensitive query. "punctuation-sensitive" A
punctuation-sensitive query. "punctuation-insensitive" A
punctuation-insensitive query. "whitespace-sensitive" A
whitespace-sensitive query. "whitespace-insensitive" A
whitespace-insensitive query. "stemmed" A stemmed query.
"unstemmed" An unstemmed query. "wildcarded" A wildcarded query.
"unwildcarded" An unwildcarded query. "exact" An exact match query.
Shorthand for "case-sensitive", "diacritic-sensitive",
"punctuation-sensitive", "whitespace-sensitive", "unstemmed", and
"unwildcarded". "lang=iso639code" Specifies the language of the
query. The iso639code code portion is case-insensitive, and uses
the languages specified by ISO 639. The default is specified in the
database configuration. "min-occurs=number" Specifies the minimum
number of occurrences required. If fewer that this number of words
occur, the fragment does not match. The default is 1.
"max-occurs=number" Specifies the maximum number of occurrences
required. If more than this number of words occur, the fragment
does not match. The default is unbounded. "synonym" Specifies that
all of the terms in the $text parameter are considered synonyms for
scoring purposes. The result is that occurrences of more than one
of the synonyms are scored as if there are more occurrences of the
same term (as opposed to having a separate term that contributes to
score). "lexicon-expand=value" The value is one of full,
prefix-postfix, off, or heuristic (the default is heuristic). An
option with a value of lexicon-expand=full specifies that wildcards
are resolved by expanding the pattern to words in a lexicon (if
there is one available), and turning into a series of
cts:word-queries, even if this takes a long time to evaluate. An
option with a value of lexicon-expand=prefix-postfix specifies that
wildcards are resolved by expanding the pattern to the pre- and
postfixes of the words in the word lexicon (if there is one), and
turning the query into a series of character queries, even if it
takes a long time to evaluate. An option with a value of
lexicon-expand=off specifies that wildcards are only resolved by
looking up character patterns in the search pattern index, not in
the lexicon. An option with a value of lexicon-expand=heuristic,
which is the default, specifies that wildcards are resolved by
using a series of internal rules, such as estimating the number of
lexicon entries that need to be scanned, seeing if the estimate
crosses certain thresholds, and (if appropriate), using another way
besides lexicon expansion to resolve the query. *
"lexicon-expansion-limit=number" Specifies the limit for lexicon
expansion. This puts a restriction on the number of lexicon
expansions that can be performed. If the limit is exceeded, the
server may raise an error depending on whether the "limit-check"
option is set. The default value for this option will be 4096.
"limit-check" Specifies that an error will be raised if the lexicon
expansion exceeds the specified limit. "no-limit-check" Specifies
that error will not be raised if the lexicon expansion exceeds the
specified limit. The server will try to resolve the wildcard. (of
xs:string)weight - A weight for this query. Higher weights
move search results up in the relevance order. The default is 1.0.
The weight should be between 64 and -16. Weights greater than 64
will have the same effect as a weight of 64. Weights less than the
absolute value of 0.0625 (between -0.0625 and 0.0625) are rounded
to 0, which means that they do not contribute to the score. (of
xs:double)CtsQueryExpr elementAttributeWordQuery(ServerExpression elementName, ServerExpression attributeName, ServerExpression text, ServerExpression options, ServerExpression weight)
Provides a client interface to the cts:element-attribute-word-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)attributeName - One or more attribute QNames to
match. When multiple QNames are specified, the query matches if any
QName matches. (of xs:QName)text - Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches. (of xs:string)options - Options to this query. The default is
(). Options include: "case-sensitive" A case-sensitive query.
"case-insensitive" A case-insensitive query. "diacritic-sensitive"
A diacritic-sensitive query. "diacritic-insensitive" A
diacritic-insensitive query. "punctuation-sensitive" A
punctuation-sensitive query. "punctuation-insensitive" A
punctuation-insensitive query. "whitespace-sensitive" A
whitespace-sensitive query. "whitespace-insensitive" A
whitespace-insensitive query. "stemmed" A stemmed query.
"unstemmed" An unstemmed query. "wildcarded" A wildcarded query.
"unwildcarded" An unwildcarded query. "exact" An exact match query.
Shorthand for "case-sensitive", "diacritic-sensitive",
"punctuation-sensitive", "whitespace-sensitive", "unstemmed", and
"unwildcarded". "lang=iso639code" Specifies the language of the
query. The iso639code code portion is case-insensitive, and uses
the languages specified by ISO 639. The default is specified in the
database configuration. "min-occurs=number" Specifies the minimum
number of occurrences required. If fewer that this number of words
occur, the fragment does not match. The default is 1.
"max-occurs=number" Specifies the maximum number of occurrences
required. If more than this number of words occur, the fragment
does not match. The default is unbounded. "synonym" Specifies that
all of the terms in the $text parameter are considered synonyms for
scoring purposes. The result is that occurrences of more than one
of the synonyms are scored as if there are more occurrences of the
same term (as opposed to having a separate term that contributes to
score). "lexicon-expand=value" The value is one of full,
prefix-postfix, off, or heuristic (the default is heuristic). An
option with a value of lexicon-expand=full specifies that wildcards
are resolved by expanding the pattern to words in a lexicon (if
there is one available), and turning into a series of
cts:word-queries, even if this takes a long time to evaluate. An
option with a value of lexicon-expand=prefix-postfix specifies that
wildcards are resolved by expanding the pattern to the pre- and
postfixes of the words in the word lexicon (if there is one), and
turning the query into a series of character queries, even if it
takes a long time to evaluate. An option with a value of
lexicon-expand=off specifies that wildcards are only resolved by
looking up character patterns in the search pattern index, not in
the lexicon. An option with a value of lexicon-expand=heuristic,
which is the default, specifies that wildcards are resolved by
using a series of internal rules, such as estimating the number of
lexicon entries that need to be scanned, seeing if the estimate
crosses certain thresholds, and (if appropriate), using another way
besides lexicon expansion to resolve the query. *
"lexicon-expansion-limit=number" Specifies the limit for lexicon
expansion. This puts a restriction on the number of lexicon
expansions that can be performed. If the limit is exceeded, the
server may raise an error depending on whether the "limit-check"
option is set. The default value for this option will be 4096.
"limit-check" Specifies that an error will be raised if the lexicon
expansion exceeds the specified limit. "no-limit-check" Specifies
that error will not be raised if the lexicon expansion exceeds the
specified limit. The server will try to resolve the wildcard. (of
xs:string)weight - A weight for this query. Higher weights
move search results up in the relevance order. The default is 1.0.
The weight should be between 64 and -16. Weights greater than 64
will have the same effect as a weight of 64. Weights less than the
absolute value of 0.0625 (between -0.0625 and 0.0625) are rounded
to 0, which means that they do not contribute to the score. (of
xs:double)CtsQueryExpr elementChildGeospatialQuery(java.lang.String elementName, java.lang.String childName, CtsRegionExpr... region)
Provides a client interface to the cts:element-child-geospatial-query server function.
elementName - One or more parent element QNames to
match. When multiple QNames are specified, the query matches if any
QName matches. (of xs:QName)childName - One or more child element QNames to
match. When multiple QNames are specified, the query matches if any
QName matches; however, only the first matching latitude child in
any point instance will be checked. The element must specify both
latitude and longitude coordinates. (of xs:QName)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)CtsQueryExpr elementChildGeospatialQuery(ServerExpression elementName, ServerExpression childName, ServerExpression region)
Provides a client interface to the cts:element-child-geospatial-query server function.
elementName - One or more parent element QNames to
match. When multiple QNames are specified, the query matches if any
QName matches. (of xs:QName)childName - One or more child element QNames to
match. When multiple QNames are specified, the query matches if any
QName matches; however, only the first matching latitude child in
any point instance will be checked. The element must specify both
latitude and longitude coordinates. (of xs:QName)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)CtsQueryExpr elementChildGeospatialQuery(java.lang.String elementName, java.lang.String childName, ServerExpression region, java.lang.String... options)
Provides a client interface to the cts:element-child-geospatial-query server function.
elementName - One or more parent element QNames to
match. When multiple QNames are specified, the query matches if any
QName matches. (of xs:QName)childName - One or more child element QNames to
match. When multiple QNames are specified, the query matches if any
QName matches; however, only the first matching latitude child in
any point instance will be checked. The element must specify both
latitude and longitude coordinates. (of xs:QName)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)options - Options to this query. The default is
(). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system with degrees as the angular unit. wgs84/radiansThe WGS84
coordinate system with radians as the angular unit. wgs84/doubleThe
WGS84 coordinate system at double precision with degrees as the
angular unit. wgs84/radians/doubleThe WGS84 coordinate system at
double precision with radians as the angular unit. etrs89The ETRS89
coordinate system. etrs89/doubleThe ETRS89 coordinate system at
double precision. rawThe raw (unmapped) coordinate system.
raw/doubleThe raw coordinate system at double precision.
"precision=string" Use the coordinate system at the given
precision. Allowed values: float (default) and double.
"units=value" Measure distance and the radii of circles in the
specified units. Allowed values: miles (default), km, feet, meters.
"boundaries-included" Points on boxes', circles', and polygons'
boundaries are counted as matching. This is the default.
"boundaries-excluded" Points on boxes', circles', and polygons'
boundaries are not counted as matching.
"boundaries-latitude-excluded" Points on boxes' latitude boundaries
are not counted as matching. "boundaries-longitude-excluded" Points
on boxes' longitude boundaries are not counted as matching.
"boundaries-south-excluded" Points on the boxes' southern
boundaries are not counted as matching. "boundaries-west-excluded"
Points on the boxes' western boundaries are not counted as
matching. "boundaries-north-excluded" Points on the boxes' northern
boundaries are not counted as matching. "boundaries-east-excluded"
Points on the boxes' eastern boundaries are not counted as
matching. "boundaries-circle-excluded" Points on circles' boundary
are not counted as matching. "boundaries-endpoints-excluded" Points
on linestrings' boundary (the endpoints) are not counted as
matching. "cached" Cache the results of this query in the list
cache. "uncached" Do not cache the results of this query in the
list cache. "type=long-lat-point" Specifies the format for the
point in the data as longitude first, latitude second. "type=point"
Specifies the format for the point in the data as latitude first,
longitude second. This is the default format.
"score-function=function" Use the selected scoring function. The
score function may be: linearUse a linear function of the
difference between the specified query value and the matching value
in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $regions parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrence of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)CtsQueryExpr elementChildGeospatialQuery(ServerExpression elementName, ServerExpression childName, ServerExpression region, ServerExpression options)
Provides a client interface to the cts:element-child-geospatial-query server function.
elementName - One or more parent element QNames to
match. When multiple QNames are specified, the query matches if any
QName matches. (of xs:QName)childName - One or more child element QNames to
match. When multiple QNames are specified, the query matches if any
QName matches; however, only the first matching latitude child in
any point instance will be checked. The element must specify both
latitude and longitude coordinates. (of xs:QName)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)options - Options to this query. The default is
(). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system with degrees as the angular unit. wgs84/radiansThe WGS84
coordinate system with radians as the angular unit. wgs84/doubleThe
WGS84 coordinate system at double precision with degrees as the
angular unit. wgs84/radians/doubleThe WGS84 coordinate system at
double precision with radians as the angular unit. etrs89The ETRS89
coordinate system. etrs89/doubleThe ETRS89 coordinate system at
double precision. rawThe raw (unmapped) coordinate system.
raw/doubleThe raw coordinate system at double precision.
"precision=string" Use the coordinate system at the given
precision. Allowed values: float (default) and double.
"units=value" Measure distance and the radii of circles in the
specified units. Allowed values: miles (default), km, feet, meters.
"boundaries-included" Points on boxes', circles', and polygons'
boundaries are counted as matching. This is the default.
"boundaries-excluded" Points on boxes', circles', and polygons'
boundaries are not counted as matching.
"boundaries-latitude-excluded" Points on boxes' latitude boundaries
are not counted as matching. "boundaries-longitude-excluded" Points
on boxes' longitude boundaries are not counted as matching.
"boundaries-south-excluded" Points on the boxes' southern
boundaries are not counted as matching. "boundaries-west-excluded"
Points on the boxes' western boundaries are not counted as
matching. "boundaries-north-excluded" Points on the boxes' northern
boundaries are not counted as matching. "boundaries-east-excluded"
Points on the boxes' eastern boundaries are not counted as
matching. "boundaries-circle-excluded" Points on circles' boundary
are not counted as matching. "boundaries-endpoints-excluded" Points
on linestrings' boundary (the endpoints) are not counted as
matching. "cached" Cache the results of this query in the list
cache. "uncached" Do not cache the results of this query in the
list cache. "type=long-lat-point" Specifies the format for the
point in the data as longitude first, latitude second. "type=point"
Specifies the format for the point in the data as latitude first,
longitude second. This is the default format.
"score-function=function" Use the selected scoring function. The
score function may be: linearUse a linear function of the
difference between the specified query value and the matching value
in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $regions parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrence of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)CtsQueryExpr elementChildGeospatialQuery(java.lang.String elementName, java.lang.String childName, ServerExpression region, java.lang.String options, double weight)
Provides a client interface to the cts:element-child-geospatial-query server function.
elementName - One or more parent element QNames to
match. When multiple QNames are specified, the query matches if any
QName matches. (of xs:QName)childName - One or more child element QNames to
match. When multiple QNames are specified, the query matches if any
QName matches; however, only the first matching latitude child in
any point instance will be checked. The element must specify both
latitude and longitude coordinates. (of xs:QName)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)options - Options to this query. The default is
(). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system with degrees as the angular unit. wgs84/radiansThe WGS84
coordinate system with radians as the angular unit. wgs84/doubleThe
WGS84 coordinate system at double precision with degrees as the
angular unit. wgs84/radians/doubleThe WGS84 coordinate system at
double precision with radians as the angular unit. etrs89The ETRS89
coordinate system. etrs89/doubleThe ETRS89 coordinate system at
double precision. rawThe raw (unmapped) coordinate system.
raw/doubleThe raw coordinate system at double precision.
"precision=string" Use the coordinate system at the given
precision. Allowed values: float (default) and double.
"units=value" Measure distance and the radii of circles in the
specified units. Allowed values: miles (default), km, feet, meters.
"boundaries-included" Points on boxes', circles', and polygons'
boundaries are counted as matching. This is the default.
"boundaries-excluded" Points on boxes', circles', and polygons'
boundaries are not counted as matching.
"boundaries-latitude-excluded" Points on boxes' latitude boundaries
are not counted as matching. "boundaries-longitude-excluded" Points
on boxes' longitude boundaries are not counted as matching.
"boundaries-south-excluded" Points on the boxes' southern
boundaries are not counted as matching. "boundaries-west-excluded"
Points on the boxes' western boundaries are not counted as
matching. "boundaries-north-excluded" Points on the boxes' northern
boundaries are not counted as matching. "boundaries-east-excluded"
Points on the boxes' eastern boundaries are not counted as
matching. "boundaries-circle-excluded" Points on circles' boundary
are not counted as matching. "boundaries-endpoints-excluded" Points
on linestrings' boundary (the endpoints) are not counted as
matching. "cached" Cache the results of this query in the list
cache. "uncached" Do not cache the results of this query in the
list cache. "type=long-lat-point" Specifies the format for the
point in the data as longitude first, latitude second. "type=point"
Specifies the format for the point in the data as latitude first,
longitude second. This is the default format.
"score-function=function" Use the selected scoring function. The
score function may be: linearUse a linear function of the
difference between the specified query value and the matching value
in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $regions parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrence of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)weight - A weight for this query. The default is
1.0. (of xs:double)CtsQueryExpr elementChildGeospatialQuery(ServerExpression elementName, ServerExpression childName, ServerExpression region, ServerExpression options, ServerExpression weight)
Provides a client interface to the cts:element-child-geospatial-query server function.
elementName - One or more parent element QNames to
match. When multiple QNames are specified, the query matches if any
QName matches. (of xs:QName)childName - One or more child element QNames to
match. When multiple QNames are specified, the query matches if any
QName matches; however, only the first matching latitude child in
any point instance will be checked. The element must specify both
latitude and longitude coordinates. (of xs:QName)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)options - Options to this query. The default is
(). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system with degrees as the angular unit. wgs84/radiansThe WGS84
coordinate system with radians as the angular unit. wgs84/doubleThe
WGS84 coordinate system at double precision with degrees as the
angular unit. wgs84/radians/doubleThe WGS84 coordinate system at
double precision with radians as the angular unit. etrs89The ETRS89
coordinate system. etrs89/doubleThe ETRS89 coordinate system at
double precision. rawThe raw (unmapped) coordinate system.
raw/doubleThe raw coordinate system at double precision.
"precision=string" Use the coordinate system at the given
precision. Allowed values: float (default) and double.
"units=value" Measure distance and the radii of circles in the
specified units. Allowed values: miles (default), km, feet, meters.
"boundaries-included" Points on boxes', circles', and polygons'
boundaries are counted as matching. This is the default.
"boundaries-excluded" Points on boxes', circles', and polygons'
boundaries are not counted as matching.
"boundaries-latitude-excluded" Points on boxes' latitude boundaries
are not counted as matching. "boundaries-longitude-excluded" Points
on boxes' longitude boundaries are not counted as matching.
"boundaries-south-excluded" Points on the boxes' southern
boundaries are not counted as matching. "boundaries-west-excluded"
Points on the boxes' western boundaries are not counted as
matching. "boundaries-north-excluded" Points on the boxes' northern
boundaries are not counted as matching. "boundaries-east-excluded"
Points on the boxes' eastern boundaries are not counted as
matching. "boundaries-circle-excluded" Points on circles' boundary
are not counted as matching. "boundaries-endpoints-excluded" Points
on linestrings' boundary (the endpoints) are not counted as
matching. "cached" Cache the results of this query in the list
cache. "uncached" Do not cache the results of this query in the
list cache. "type=long-lat-point" Specifies the format for the
point in the data as longitude first, latitude second. "type=point"
Specifies the format for the point in the data as latitude first,
longitude second. This is the default format.
"score-function=function" Use the selected scoring function. The
score function may be: linearUse a linear function of the
difference between the specified query value and the matching value
in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $regions parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrence of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)weight - A weight for this query. The default is
1.0. (of xs:double)CtsQueryExpr elementGeospatialQuery(java.lang.String elementName, CtsRegionExpr... region)
Provides a client interface to the cts:element-geospatial-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)CtsQueryExpr elementGeospatialQuery(ServerExpression elementName, ServerExpression region)
Provides a client interface to the cts:element-geospatial-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)CtsQueryExpr elementGeospatialQuery(java.lang.String elementName, ServerExpression region, java.lang.String... options)
Provides a client interface to the cts:element-geospatial-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)options - Options to this query. The default is
(). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system with degrees as the angular unit. wgs84/radiansThe WGS84
coordinate system with radians as the angular unit. wgs84/doubleThe
WGS84 coordinate system at double precision with degrees as the
angular unit. wgs84/radians/doubleThe WGS84 coordinate system at
double precision with radians as the angular unit. etrs89The ETRS89
coordinate system. etrs89/doubleThe ETRS89 coordinate system at
double precision. rawThe raw (unmapped) coordinate system.
raw/doubleThe raw coordinate system at double precision.
"precision=value" Use the coordinate system at the given precision.
Allowed values: float and double. "units=value" Measure distance
and the radii of circles in the specified units. Allowed values:
miles (default), km, feet, meters. "boundaries-included" Points on
boxes', circles', and polygons' boundaries are counted as matching.
This is the default. "boundaries-excluded" Points on boxes',
circles', and polygons' boundaries are not counted as matching.
"boundaries-latitude-excluded" Points on boxes' latitude boundaries
are not counted as matching. "boundaries-longitude-excluded" Points
on boxes' longitude boundaries are not counted as matching.
"boundaries-south-excluded" Points on the boxes' southern
boundaries are not counted as matching. "boundaries-west-excluded"
Points on the boxes' western boundaries are not counted as
matching. "boundaries-north-excluded" Points on the boxes' northern
boundaries are not counted as matching. "boundaries-east-excluded"
Points on the boxes' eastern boundaries are not counted as
matching. "boundaries-circle-excluded" Points on circles' boundary
are not counted as matching. "boundaries-endpoints-excluded" Points
on linestrings' boundary (the endpoints) are not counted as
matching. "cached" Cache the results of this query in the list
cache. "uncached" Do not cache the results of this query in the
list cache. "type=long-lat-point" Specifies the format for the
point in the data as longitude first, latitude second. "type=point"
Specifies the format for the point in the data as latitude first,
longitude second. This is the default format.
"score-function=function" Use the selected scoring function. The
score function may be: linearUse a linear function of the
difference between the specified query value and the matching value
in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $regions parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrence of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)CtsQueryExpr elementGeospatialQuery(ServerExpression elementName, ServerExpression region, ServerExpression options)
Provides a client interface to the cts:element-geospatial-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)options - Options to this query. The default is
(). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system with degrees as the angular unit. wgs84/radiansThe WGS84
coordinate system with radians as the angular unit. wgs84/doubleThe
WGS84 coordinate system at double precision with degrees as the
angular unit. wgs84/radians/doubleThe WGS84 coordinate system at
double precision with radians as the angular unit. etrs89The ETRS89
coordinate system. etrs89/doubleThe ETRS89 coordinate system at
double precision. rawThe raw (unmapped) coordinate system.
raw/doubleThe raw coordinate system at double precision.
"precision=value" Use the coordinate system at the given precision.
Allowed values: float and double. "units=value" Measure distance
and the radii of circles in the specified units. Allowed values:
miles (default), km, feet, meters. "boundaries-included" Points on
boxes', circles', and polygons' boundaries are counted as matching.
This is the default. "boundaries-excluded" Points on boxes',
circles', and polygons' boundaries are not counted as matching.
"boundaries-latitude-excluded" Points on boxes' latitude boundaries
are not counted as matching. "boundaries-longitude-excluded" Points
on boxes' longitude boundaries are not counted as matching.
"boundaries-south-excluded" Points on the boxes' southern
boundaries are not counted as matching. "boundaries-west-excluded"
Points on the boxes' western boundaries are not counted as
matching. "boundaries-north-excluded" Points on the boxes' northern
boundaries are not counted as matching. "boundaries-east-excluded"
Points on the boxes' eastern boundaries are not counted as
matching. "boundaries-circle-excluded" Points on circles' boundary
are not counted as matching. "boundaries-endpoints-excluded" Points
on linestrings' boundary (the endpoints) are not counted as
matching. "cached" Cache the results of this query in the list
cache. "uncached" Do not cache the results of this query in the
list cache. "type=long-lat-point" Specifies the format for the
point in the data as longitude first, latitude second. "type=point"
Specifies the format for the point in the data as latitude first,
longitude second. This is the default format.
"score-function=function" Use the selected scoring function. The
score function may be: linearUse a linear function of the
difference between the specified query value and the matching value
in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $regions parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrence of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)CtsQueryExpr elementGeospatialQuery(java.lang.String elementName, ServerExpression region, java.lang.String options, double weight)
Provides a client interface to the cts:element-geospatial-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)options - Options to this query. The default is
(). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system with degrees as the angular unit. wgs84/radiansThe WGS84
coordinate system with radians as the angular unit. wgs84/doubleThe
WGS84 coordinate system at double precision with degrees as the
angular unit. wgs84/radians/doubleThe WGS84 coordinate system at
double precision with radians as the angular unit. etrs89The ETRS89
coordinate system. etrs89/doubleThe ETRS89 coordinate system at
double precision. rawThe raw (unmapped) coordinate system.
raw/doubleThe raw coordinate system at double precision.
"precision=value" Use the coordinate system at the given precision.
Allowed values: float and double. "units=value" Measure distance
and the radii of circles in the specified units. Allowed values:
miles (default), km, feet, meters. "boundaries-included" Points on
boxes', circles', and polygons' boundaries are counted as matching.
This is the default. "boundaries-excluded" Points on boxes',
circles', and polygons' boundaries are not counted as matching.
"boundaries-latitude-excluded" Points on boxes' latitude boundaries
are not counted as matching. "boundaries-longitude-excluded" Points
on boxes' longitude boundaries are not counted as matching.
"boundaries-south-excluded" Points on the boxes' southern
boundaries are not counted as matching. "boundaries-west-excluded"
Points on the boxes' western boundaries are not counted as
matching. "boundaries-north-excluded" Points on the boxes' northern
boundaries are not counted as matching. "boundaries-east-excluded"
Points on the boxes' eastern boundaries are not counted as
matching. "boundaries-circle-excluded" Points on circles' boundary
are not counted as matching. "boundaries-endpoints-excluded" Points
on linestrings' boundary (the endpoints) are not counted as
matching. "cached" Cache the results of this query in the list
cache. "uncached" Do not cache the results of this query in the
list cache. "type=long-lat-point" Specifies the format for the
point in the data as longitude first, latitude second. "type=point"
Specifies the format for the point in the data as latitude first,
longitude second. This is the default format.
"score-function=function" Use the selected scoring function. The
score function may be: linearUse a linear function of the
difference between the specified query value and the matching value
in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $regions parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrence of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)weight - A weight for this query. The default is
1.0. (of xs:double)CtsQueryExpr elementGeospatialQuery(ServerExpression elementName, ServerExpression region, ServerExpression options, ServerExpression weight)
Provides a client interface to the cts:element-geospatial-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)options - Options to this query. The default is
(). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system with degrees as the angular unit. wgs84/radiansThe WGS84
coordinate system with radians as the angular unit. wgs84/doubleThe
WGS84 coordinate system at double precision with degrees as the
angular unit. wgs84/radians/doubleThe WGS84 coordinate system at
double precision with radians as the angular unit. etrs89The ETRS89
coordinate system. etrs89/doubleThe ETRS89 coordinate system at
double precision. rawThe raw (unmapped) coordinate system.
raw/doubleThe raw coordinate system at double precision.
"precision=value" Use the coordinate system at the given precision.
Allowed values: float and double. "units=value" Measure distance
and the radii of circles in the specified units. Allowed values:
miles (default), km, feet, meters. "boundaries-included" Points on
boxes', circles', and polygons' boundaries are counted as matching.
This is the default. "boundaries-excluded" Points on boxes',
circles', and polygons' boundaries are not counted as matching.
"boundaries-latitude-excluded" Points on boxes' latitude boundaries
are not counted as matching. "boundaries-longitude-excluded" Points
on boxes' longitude boundaries are not counted as matching.
"boundaries-south-excluded" Points on the boxes' southern
boundaries are not counted as matching. "boundaries-west-excluded"
Points on the boxes' western boundaries are not counted as
matching. "boundaries-north-excluded" Points on the boxes' northern
boundaries are not counted as matching. "boundaries-east-excluded"
Points on the boxes' eastern boundaries are not counted as
matching. "boundaries-circle-excluded" Points on circles' boundary
are not counted as matching. "boundaries-endpoints-excluded" Points
on linestrings' boundary (the endpoints) are not counted as
matching. "cached" Cache the results of this query in the list
cache. "uncached" Do not cache the results of this query in the
list cache. "type=long-lat-point" Specifies the format for the
point in the data as longitude first, latitude second. "type=point"
Specifies the format for the point in the data as latitude first,
longitude second. This is the default format.
"score-function=function" Use the selected scoring function. The
score function may be: linearUse a linear function of the
difference between the specified query value and the matching value
in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $regions parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrence of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)weight - A weight for this query. The default is
1.0. (of xs:double)CtsQueryExpr elementPairGeospatialQuery(java.lang.String elementName, java.lang.String latitudeName, java.lang.String longitudeName, CtsRegionExpr... region)
Provides a client interface to the cts:element-pair-geospatial-query server function.
elementName - One or more parent element QNames to
match. When multiple QNames are specified, the query matches if any
QName matches. (of xs:QName)latitudeName - One or more latitude element QNames
to match. When multiple QNames are specified, the query matches if
any QName matches; however, only the first matching latitude child
in any point instance will be checked. (of xs:QName)longitudeName - One or more longitude element
QNames to match. When multiple QNames are specified, the query
matches if any QName matches; however, only the first matching
longitude child in any point instance will be checked. (of xs:QName)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)CtsQueryExpr elementPairGeospatialQuery(ServerExpression elementName, ServerExpression latitudeName, ServerExpression longitudeName, ServerExpression region)
Provides a client interface to the cts:element-pair-geospatial-query server function.
elementName - One or more parent element QNames to
match. When multiple QNames are specified, the query matches if any
QName matches. (of xs:QName)latitudeName - One or more latitude element QNames
to match. When multiple QNames are specified, the query matches if
any QName matches; however, only the first matching latitude child
in any point instance will be checked. (of xs:QName)longitudeName - One or more longitude element
QNames to match. When multiple QNames are specified, the query
matches if any QName matches; however, only the first matching
longitude child in any point instance will be checked. (of xs:QName)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)CtsQueryExpr elementPairGeospatialQuery(java.lang.String elementName, java.lang.String latitudeName, java.lang.String longitudeName, ServerExpression region, java.lang.String... options)
Provides a client interface to the cts:element-pair-geospatial-query server function.
elementName - One or more parent element QNames to
match. When multiple QNames are specified, the query matches if any
QName matches. (of xs:QName)latitudeName - One or more latitude element QNames
to match. When multiple QNames are specified, the query matches if
any QName matches; however, only the first matching latitude child
in any point instance will be checked. (of xs:QName)longitudeName - One or more longitude element
QNames to match. When multiple QNames are specified, the query
matches if any QName matches; however, only the first matching
longitude child in any point instance will be checked. (of xs:QName)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)options - Options to this query. The default is
(). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system with degrees as the angular unit. wgs84/radiansThe WGS84
coordinate system with radians as the angular unit. wgs84/doubleThe
WGS84 coordinate system at double precision with degrees as the
angular unit. wgs84/radians/doubleThe WGS84 coordinate system at
double precision with radians as the angular unit. etrs89The ETRS89
coordinate system. etrs89/doubleThe ETRS89 coordinate system at
double precision. rawThe raw (unmapped) coordinate system.
raw/doubleThe raw coordinate system at double precision.
"precision=value" Use the coordinate system at the given precision.
Allowed values: float and double. "units=value" Measure distance
and the radii of circles in the specified units. Allowed values:
miles (default), km, feet, meters. "boundaries-included" Points on
boxes', circles', and polygons' boundaries are counted as matching.
This is the default. "boundaries-excluded" Points on boxes',
circles', and polygons' boundaries are not counted as matching.
"boundaries-latitude-excluded" Points on boxes' latitude boundaries
are not counted as matching. "boundaries-longitude-excluded" Points
on boxes' longitude boundaries are not counted as matching.
"boundaries-south-excluded" Points on the boxes' southern
boundaries are not counted as matching. "boundaries-west-excluded"
Points on the boxes' western boundaries are not counted as
matching. "boundaries-north-excluded" Points on the boxes' northern
boundaries are not counted as matching. "boundaries-east-excluded"
Points on the boxes' eastern boundaries are not counted as
matching. "boundaries-circle-excluded" Points on circles' boundary
are not counted as matching. "boundaries-endpoints-excluded" Points
on linestrings' boundary (the endpoints) are not counted as
matching. "cached" Cache the results of this query in the list
cache. "uncached" Do not cache the results of this query in the
list cache. "score-function=function" Use the selected scoring
function. The score function may be: linearUse a linear function of
the difference between the specified query value and the matching
value in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $regions parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrence of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)CtsQueryExpr elementPairGeospatialQuery(ServerExpression elementName, ServerExpression latitudeName, ServerExpression longitudeName, ServerExpression region, ServerExpression options)
Provides a client interface to the cts:element-pair-geospatial-query server function.
elementName - One or more parent element QNames to
match. When multiple QNames are specified, the query matches if any
QName matches. (of xs:QName)latitudeName - One or more latitude element QNames
to match. When multiple QNames are specified, the query matches if
any QName matches; however, only the first matching latitude child
in any point instance will be checked. (of xs:QName)longitudeName - One or more longitude element
QNames to match. When multiple QNames are specified, the query
matches if any QName matches; however, only the first matching
longitude child in any point instance will be checked. (of xs:QName)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)options - Options to this query. The default is
(). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system with degrees as the angular unit. wgs84/radiansThe WGS84
coordinate system with radians as the angular unit. wgs84/doubleThe
WGS84 coordinate system at double precision with degrees as the
angular unit. wgs84/radians/doubleThe WGS84 coordinate system at
double precision with radians as the angular unit. etrs89The ETRS89
coordinate system. etrs89/doubleThe ETRS89 coordinate system at
double precision. rawThe raw (unmapped) coordinate system.
raw/doubleThe raw coordinate system at double precision.
"precision=value" Use the coordinate system at the given precision.
Allowed values: float and double. "units=value" Measure distance
and the radii of circles in the specified units. Allowed values:
miles (default), km, feet, meters. "boundaries-included" Points on
boxes', circles', and polygons' boundaries are counted as matching.
This is the default. "boundaries-excluded" Points on boxes',
circles', and polygons' boundaries are not counted as matching.
"boundaries-latitude-excluded" Points on boxes' latitude boundaries
are not counted as matching. "boundaries-longitude-excluded" Points
on boxes' longitude boundaries are not counted as matching.
"boundaries-south-excluded" Points on the boxes' southern
boundaries are not counted as matching. "boundaries-west-excluded"
Points on the boxes' western boundaries are not counted as
matching. "boundaries-north-excluded" Points on the boxes' northern
boundaries are not counted as matching. "boundaries-east-excluded"
Points on the boxes' eastern boundaries are not counted as
matching. "boundaries-circle-excluded" Points on circles' boundary
are not counted as matching. "boundaries-endpoints-excluded" Points
on linestrings' boundary (the endpoints) are not counted as
matching. "cached" Cache the results of this query in the list
cache. "uncached" Do not cache the results of this query in the
list cache. "score-function=function" Use the selected scoring
function. The score function may be: linearUse a linear function of
the difference between the specified query value and the matching
value in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $regions parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrence of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)CtsQueryExpr elementPairGeospatialQuery(java.lang.String elementName, java.lang.String latitudeName, java.lang.String longitudeName, ServerExpression region, java.lang.String options, double weight)
Provides a client interface to the cts:element-pair-geospatial-query server function.
elementName - One or more parent element QNames to
match. When multiple QNames are specified, the query matches if any
QName matches. (of xs:QName)latitudeName - One or more latitude element QNames
to match. When multiple QNames are specified, the query matches if
any QName matches; however, only the first matching latitude child
in any point instance will be checked. (of xs:QName)longitudeName - One or more longitude element
QNames to match. When multiple QNames are specified, the query
matches if any QName matches; however, only the first matching
longitude child in any point instance will be checked. (of xs:QName)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)options - Options to this query. The default is
(). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system with degrees as the angular unit. wgs84/radiansThe WGS84
coordinate system with radians as the angular unit. wgs84/doubleThe
WGS84 coordinate system at double precision with degrees as the
angular unit. wgs84/radians/doubleThe WGS84 coordinate system at
double precision with radians as the angular unit. etrs89The ETRS89
coordinate system. etrs89/doubleThe ETRS89 coordinate system at
double precision. rawThe raw (unmapped) coordinate system.
raw/doubleThe raw coordinate system at double precision.
"precision=value" Use the coordinate system at the given precision.
Allowed values: float and double. "units=value" Measure distance
and the radii of circles in the specified units. Allowed values:
miles (default), km, feet, meters. "boundaries-included" Points on
boxes', circles', and polygons' boundaries are counted as matching.
This is the default. "boundaries-excluded" Points on boxes',
circles', and polygons' boundaries are not counted as matching.
"boundaries-latitude-excluded" Points on boxes' latitude boundaries
are not counted as matching. "boundaries-longitude-excluded" Points
on boxes' longitude boundaries are not counted as matching.
"boundaries-south-excluded" Points on the boxes' southern
boundaries are not counted as matching. "boundaries-west-excluded"
Points on the boxes' western boundaries are not counted as
matching. "boundaries-north-excluded" Points on the boxes' northern
boundaries are not counted as matching. "boundaries-east-excluded"
Points on the boxes' eastern boundaries are not counted as
matching. "boundaries-circle-excluded" Points on circles' boundary
are not counted as matching. "boundaries-endpoints-excluded" Points
on linestrings' boundary (the endpoints) are not counted as
matching. "cached" Cache the results of this query in the list
cache. "uncached" Do not cache the results of this query in the
list cache. "score-function=function" Use the selected scoring
function. The score function may be: linearUse a linear function of
the difference between the specified query value and the matching
value in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $regions parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrence of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)weight - A weight for this query. The default is
1.0. (of xs:double)CtsQueryExpr elementPairGeospatialQuery(ServerExpression elementName, ServerExpression latitudeName, ServerExpression longitudeName, ServerExpression region, ServerExpression options, ServerExpression weight)
Provides a client interface to the cts:element-pair-geospatial-query server function.
elementName - One or more parent element QNames to
match. When multiple QNames are specified, the query matches if any
QName matches. (of xs:QName)latitudeName - One or more latitude element QNames
to match. When multiple QNames are specified, the query matches if
any QName matches; however, only the first matching latitude child
in any point instance will be checked. (of xs:QName)longitudeName - One or more longitude element
QNames to match. When multiple QNames are specified, the query
matches if any QName matches; however, only the first matching
longitude child in any point instance will be checked. (of xs:QName)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)options - Options to this query. The default is
(). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system with degrees as the angular unit. wgs84/radiansThe WGS84
coordinate system with radians as the angular unit. wgs84/doubleThe
WGS84 coordinate system at double precision with degrees as the
angular unit. wgs84/radians/doubleThe WGS84 coordinate system at
double precision with radians as the angular unit. etrs89The ETRS89
coordinate system. etrs89/doubleThe ETRS89 coordinate system at
double precision. rawThe raw (unmapped) coordinate system.
raw/doubleThe raw coordinate system at double precision.
"precision=value" Use the coordinate system at the given precision.
Allowed values: float and double. "units=value" Measure distance
and the radii of circles in the specified units. Allowed values:
miles (default), km, feet, meters. "boundaries-included" Points on
boxes', circles', and polygons' boundaries are counted as matching.
This is the default. "boundaries-excluded" Points on boxes',
circles', and polygons' boundaries are not counted as matching.
"boundaries-latitude-excluded" Points on boxes' latitude boundaries
are not counted as matching. "boundaries-longitude-excluded" Points
on boxes' longitude boundaries are not counted as matching.
"boundaries-south-excluded" Points on the boxes' southern
boundaries are not counted as matching. "boundaries-west-excluded"
Points on the boxes' western boundaries are not counted as
matching. "boundaries-north-excluded" Points on the boxes' northern
boundaries are not counted as matching. "boundaries-east-excluded"
Points on the boxes' eastern boundaries are not counted as
matching. "boundaries-circle-excluded" Points on circles' boundary
are not counted as matching. "boundaries-endpoints-excluded" Points
on linestrings' boundary (the endpoints) are not counted as
matching. "cached" Cache the results of this query in the list
cache. "uncached" Do not cache the results of this query in the
list cache. "score-function=function" Use the selected scoring
function. The score function may be: linearUse a linear function of
the difference between the specified query value and the matching
value in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $regions parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrence of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)weight - A weight for this query. The default is
1.0. (of xs:double)CtsQueryExpr elementQuery(java.lang.String elementName, ServerExpression query)
Provides a client interface to the cts:element-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)query - A query for the element to match. If a
string is entered, the string is treated as a cts:word-query of the
specified string. (of cts:query)CtsQueryExpr elementQuery(ServerExpression elementName, ServerExpression query)
Provides a client interface to the cts:element-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)query - A query for the element to match. If a
string is entered, the string is treated as a cts:word-query of the
specified string. (of cts:query)CtsQueryExpr elementRangeQuery(java.lang.String elementName, java.lang.String operator, java.lang.String value)
Provides a client interface to the cts:element-range-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)operator - A comparison operator. Operators
include: "<" Match range index values less than $value. "<="
Match range index values less than or equal to $value. ">" Match
range index values greater than $value. ">=" Match range index
values greater than or equal to $value. "=" Match range index
values equal to $value. "!=" Match range index values not equal to
$value. (of xs:string)value - One or more element values to match. When
multiple values are specified, the query matches if any value
matches. (of xs:anyAtomicType)CtsQueryExpr elementRangeQuery(ServerExpression elementName, ServerExpression operator, ServerExpression value)
Provides a client interface to the cts:element-range-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)operator - A comparison operator. Operators
include: "<" Match range index values less than $value. "<="
Match range index values less than or equal to $value. ">" Match
range index values greater than $value. ">=" Match range index
values greater than or equal to $value. "=" Match range index
values equal to $value. "!=" Match range index values not equal to
$value. (of xs:string)value - One or more element values to match. When
multiple values are specified, the query matches if any value
matches. (of xs:anyAtomicType)CtsQueryExpr elementRangeQuery(java.lang.String elementName, java.lang.String operator, java.lang.String value, java.lang.String... options)
Provides a client interface to the cts:element-range-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)operator - A comparison operator. Operators
include: "<" Match range index values less than $value. "<="
Match range index values less than or equal to $value. ">" Match
range index values greater than $value. ">=" Match range index
values greater than or equal to $value. "=" Match range index
values equal to $value. "!=" Match range index values not equal to
$value. (of xs:string)value - One or more element values to match. When
multiple values are specified, the query matches if any value
matches. (of xs:anyAtomicType)options - Options to this query. The default is
(). Options include: "collation=URI" Use the range index with the
collation specified by URI. If not specified, then the default
collation from the query is used. If a range index with the
specified collation does not exist, an error is thrown. "cached"
Cache the results of this query in the list cache. "uncached" Do
not cache the results of this query in the list cache.
"cached-incremental" When querying on a short date or dateTime
range, break the query into sub-queries on smaller ranges, and then
cache the results of each. See the Usage Notes for details.
"min-occurs=number" Specifies the minimum number of occurrences
required. If fewer that this number of words occur, the fragment
does not match. The default is 1. "max-occurs=number" Specifies the
maximum number of occurrences required. If more than this number of
words occur, the fragment does not match. The default is unbounded.
"score-function=function" Use the selected scoring function. The
score function may be: linearUse a linear function of the
difference between the specified query value and the matching value
in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $value parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrences of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)CtsQueryExpr elementRangeQuery(ServerExpression elementName, ServerExpression operator, ServerExpression value, ServerExpression options)
Provides a client interface to the cts:element-range-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)operator - A comparison operator. Operators
include: "<" Match range index values less than $value. "<="
Match range index values less than or equal to $value. ">" Match
range index values greater than $value. ">=" Match range index
values greater than or equal to $value. "=" Match range index
values equal to $value. "!=" Match range index values not equal to
$value. (of xs:string)value - One or more element values to match. When
multiple values are specified, the query matches if any value
matches. (of xs:anyAtomicType)options - Options to this query. The default is
(). Options include: "collation=URI" Use the range index with the
collation specified by URI. If not specified, then the default
collation from the query is used. If a range index with the
specified collation does not exist, an error is thrown. "cached"
Cache the results of this query in the list cache. "uncached" Do
not cache the results of this query in the list cache.
"cached-incremental" When querying on a short date or dateTime
range, break the query into sub-queries on smaller ranges, and then
cache the results of each. See the Usage Notes for details.
"min-occurs=number" Specifies the minimum number of occurrences
required. If fewer that this number of words occur, the fragment
does not match. The default is 1. "max-occurs=number" Specifies the
maximum number of occurrences required. If more than this number of
words occur, the fragment does not match. The default is unbounded.
"score-function=function" Use the selected scoring function. The
score function may be: linearUse a linear function of the
difference between the specified query value and the matching value
in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $value parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrences of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)CtsQueryExpr elementRangeQuery(java.lang.String elementName, java.lang.String operator, java.lang.String value, java.lang.String options, double weight)
Provides a client interface to the cts:element-range-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)operator - A comparison operator. Operators
include: "<" Match range index values less than $value. "<="
Match range index values less than or equal to $value. ">" Match
range index values greater than $value. ">=" Match range index
values greater than or equal to $value. "=" Match range index
values equal to $value. "!=" Match range index values not equal to
$value. (of xs:string)value - One or more element values to match. When
multiple values are specified, the query matches if any value
matches. (of xs:anyAtomicType)options - Options to this query. The default is
(). Options include: "collation=URI" Use the range index with the
collation specified by URI. If not specified, then the default
collation from the query is used. If a range index with the
specified collation does not exist, an error is thrown. "cached"
Cache the results of this query in the list cache. "uncached" Do
not cache the results of this query in the list cache.
"cached-incremental" When querying on a short date or dateTime
range, break the query into sub-queries on smaller ranges, and then
cache the results of each. See the Usage Notes for details.
"min-occurs=number" Specifies the minimum number of occurrences
required. If fewer that this number of words occur, the fragment
does not match. The default is 1. "max-occurs=number" Specifies the
maximum number of occurrences required. If more than this number of
words occur, the fragment does not match. The default is unbounded.
"score-function=function" Use the selected scoring function. The
score function may be: linearUse a linear function of the
difference between the specified query value and the matching value
in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $value parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrences of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)weight - A weight for this query. The default is
1.0. (of xs:double)CtsQueryExpr elementRangeQuery(ServerExpression elementName, ServerExpression operator, ServerExpression value, ServerExpression options, ServerExpression weight)
Provides a client interface to the cts:element-range-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)operator - A comparison operator. Operators
include: "<" Match range index values less than $value. "<="
Match range index values less than or equal to $value. ">" Match
range index values greater than $value. ">=" Match range index
values greater than or equal to $value. "=" Match range index
values equal to $value. "!=" Match range index values not equal to
$value. (of xs:string)value - One or more element values to match. When
multiple values are specified, the query matches if any value
matches. (of xs:anyAtomicType)options - Options to this query. The default is
(). Options include: "collation=URI" Use the range index with the
collation specified by URI. If not specified, then the default
collation from the query is used. If a range index with the
specified collation does not exist, an error is thrown. "cached"
Cache the results of this query in the list cache. "uncached" Do
not cache the results of this query in the list cache.
"cached-incremental" When querying on a short date or dateTime
range, break the query into sub-queries on smaller ranges, and then
cache the results of each. See the Usage Notes for details.
"min-occurs=number" Specifies the minimum number of occurrences
required. If fewer that this number of words occur, the fragment
does not match. The default is 1. "max-occurs=number" Specifies the
maximum number of occurrences required. If more than this number of
words occur, the fragment does not match. The default is unbounded.
"score-function=function" Use the selected scoring function. The
score function may be: linearUse a linear function of the
difference between the specified query value and the matching value
in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $value parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrences of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)weight - A weight for this query. The default is
1.0. (of xs:double)CtsReferenceExpr elementReference(java.lang.String element)
Provides a client interface to the cts:element-reference server function.
element - An element QName. (of xs:QName)CtsReferenceExpr elementReference(ServerExpression element)
Provides a client interface to the cts:element-reference server function.
element - An element QName. (of xs:QName)CtsReferenceExpr elementReference(java.lang.String element, java.lang.String options)
Provides a client interface to the cts:element-reference server function.
element - An element QName. (of xs:QName)options - Options. The default is (). Options
include: "type=type" Use the lexicon with the type specified by
type (int, unsignedInt, long, unsignedLong, float, double, decimal,
dateTime, time, date, gYearMonth, gYear, gMonth, gDay,
yearMonthDuration, dayTimeDuration, string, anyURI, point, or
long-lat-point) "collation=URI" Use the lexicon with the collation
specified by URI. "nullable" Allow null values in tuples reported
from cts:value-tuples when using this lexicon. "unchecked" Read the
scalar type, collation and coordinate-system info only from the
input. Do not check the definition against the context database.
"coordinate-system=name" Create a reference to an index or lexicon
based on the specified coordinate system. Allowed values: "wgs84",
"wgs84/double", "raw", "raw/double". Only applicable if the
index/lexicon value type is point or long-lat-point.
"precision=value" Create a reference to an index or lexicon
configured with the specified geospatial precision. Allowed values:
float and double. Only applicable if the index/lexicon value type
is point or long-lat-point. This value takes precedence over the
precision implicit in the coordinate system name. (of xs:string)CtsReferenceExpr elementReference(ServerExpression element, ServerExpression options)
Provides a client interface to the cts:element-reference server function.
element - An element QName. (of xs:QName)options - Options. The default is (). Options
include: "type=type" Use the lexicon with the type specified by
type (int, unsignedInt, long, unsignedLong, float, double, decimal,
dateTime, time, date, gYearMonth, gYear, gMonth, gDay,
yearMonthDuration, dayTimeDuration, string, anyURI, point, or
long-lat-point) "collation=URI" Use the lexicon with the collation
specified by URI. "nullable" Allow null values in tuples reported
from cts:value-tuples when using this lexicon. "unchecked" Read the
scalar type, collation and coordinate-system info only from the
input. Do not check the definition against the context database.
"coordinate-system=name" Create a reference to an index or lexicon
based on the specified coordinate system. Allowed values: "wgs84",
"wgs84/double", "raw", "raw/double". Only applicable if the
index/lexicon value type is point or long-lat-point.
"precision=value" Create a reference to an index or lexicon
configured with the specified geospatial precision. Allowed values:
float and double. Only applicable if the index/lexicon value type
is point or long-lat-point. This value takes precedence over the
precision implicit in the coordinate system name. (of xs:string)CtsQueryExpr elementValueQuery(java.lang.String elementName)
Provides a client interface to the cts:element-value-query server function.
CtsQueryExpr elementValueQuery(ServerExpression elementName)
Provides a client interface to the cts:element-value-query server function.
CtsQueryExpr elementValueQuery(java.lang.String elementName, java.lang.String text)
Provides a client interface to the cts:element-value-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)text - One or more element values to match. When
multiple strings are specified, the query matches if any string
matches. (of xs:string)CtsQueryExpr elementValueQuery(ServerExpression elementName, ServerExpression text)
Provides a client interface to the cts:element-value-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)text - One or more element values to match. When
multiple strings are specified, the query matches if any string
matches. (of xs:string)CtsQueryExpr elementValueQuery(java.lang.String elementName, java.lang.String text, java.lang.String... options)
Provides a client interface to the cts:element-value-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)text - One or more element values to match. When
multiple strings are specified, the query matches if any string
matches. (of xs:string)options - Options to this query. The default is
(). Options include: "case-sensitive" A case-sensitive query.
"case-insensitive" A case-insensitive query. "diacritic-sensitive"
A diacritic-sensitive query. "diacritic-insensitive" A
diacritic-insensitive query. "punctuation-sensitive" A
punctuation-sensitive query. "punctuation-insensitive" A
punctuation-insensitive query. "whitespace-sensitive" A
whitespace-sensitive query. "whitespace-insensitive" A
whitespace-insensitive query. "stemmed" A stemmed query.
"unstemmed" An unstemmed query. "wildcarded" A wildcarded query.
"unwildcarded" An unwildcarded query. "exact" An exact match query.
Shorthand for "case-sensitive", "diacritic-sensitive",
"punctuation-sensitive", "whitespace-sensitive", "unstemmed", and
"unwildcarded". "lang=iso639code" Specifies the language of the
query. The iso639code code portion is case-insensitive, and uses
the languages specified by ISO 639. The default is specified in the
database configuration. "min-occurs=number" Specifies the minimum
number of occurrences required. If fewer that this number of words
occur, the fragment does not match. The default is 1.
"max-occurs=number" Specifies the maximum number of occurrences
required. If more than this number of words occur, the fragment
does not match. The default is unbounded. "synonym" Specifies that
all of the terms in the $text parameter are considered synonyms for
scoring purposes. The result is that occurrences of more than one
of the synonyms are scored as if there are more occurrences of the
same term (as opposed to having a separate term that contributes to
score). "lexicon-expansion-limit=number" Specifies the limit for
lexicon expansion. This puts a restriction on the number of lexicon
expansions that can be performed. If the limit is exceeded, the
server may raise an error depending on whether the "limit-check"
option is set. The default value for this option will be 4096.
"limit-check" Specifies that an error will be raised if the lexicon
expansion exceeds the specified limit. "no-limit-check" Specifies
that error will not be raised if the lexicon expansion exceeds the
specified limit. The server will try to resolve the wildcard. (of
xs:string)CtsQueryExpr elementValueQuery(ServerExpression elementName, ServerExpression text, ServerExpression options)
Provides a client interface to the cts:element-value-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)text - One or more element values to match. When
multiple strings are specified, the query matches if any string
matches. (of xs:string)options - Options to this query. The default is
(). Options include: "case-sensitive" A case-sensitive query.
"case-insensitive" A case-insensitive query. "diacritic-sensitive"
A diacritic-sensitive query. "diacritic-insensitive" A
diacritic-insensitive query. "punctuation-sensitive" A
punctuation-sensitive query. "punctuation-insensitive" A
punctuation-insensitive query. "whitespace-sensitive" A
whitespace-sensitive query. "whitespace-insensitive" A
whitespace-insensitive query. "stemmed" A stemmed query.
"unstemmed" An unstemmed query. "wildcarded" A wildcarded query.
"unwildcarded" An unwildcarded query. "exact" An exact match query.
Shorthand for "case-sensitive", "diacritic-sensitive",
"punctuation-sensitive", "whitespace-sensitive", "unstemmed", and
"unwildcarded". "lang=iso639code" Specifies the language of the
query. The iso639code code portion is case-insensitive, and uses
the languages specified by ISO 639. The default is specified in the
database configuration. "min-occurs=number" Specifies the minimum
number of occurrences required. If fewer that this number of words
occur, the fragment does not match. The default is 1.
"max-occurs=number" Specifies the maximum number of occurrences
required. If more than this number of words occur, the fragment
does not match. The default is unbounded. "synonym" Specifies that
all of the terms in the $text parameter are considered synonyms for
scoring purposes. The result is that occurrences of more than one
of the synonyms are scored as if there are more occurrences of the
same term (as opposed to having a separate term that contributes to
score). "lexicon-expansion-limit=number" Specifies the limit for
lexicon expansion. This puts a restriction on the number of lexicon
expansions that can be performed. If the limit is exceeded, the
server may raise an error depending on whether the "limit-check"
option is set. The default value for this option will be 4096.
"limit-check" Specifies that an error will be raised if the lexicon
expansion exceeds the specified limit. "no-limit-check" Specifies
that error will not be raised if the lexicon expansion exceeds the
specified limit. The server will try to resolve the wildcard. (of
xs:string)CtsQueryExpr elementValueQuery(java.lang.String elementName, java.lang.String text, java.lang.String options, double weight)
Provides a client interface to the cts:element-value-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)text - One or more element values to match. When
multiple strings are specified, the query matches if any string
matches. (of xs:string)options - Options to this query. The default is
(). Options include: "case-sensitive" A case-sensitive query.
"case-insensitive" A case-insensitive query. "diacritic-sensitive"
A diacritic-sensitive query. "diacritic-insensitive" A
diacritic-insensitive query. "punctuation-sensitive" A
punctuation-sensitive query. "punctuation-insensitive" A
punctuation-insensitive query. "whitespace-sensitive" A
whitespace-sensitive query. "whitespace-insensitive" A
whitespace-insensitive query. "stemmed" A stemmed query.
"unstemmed" An unstemmed query. "wildcarded" A wildcarded query.
"unwildcarded" An unwildcarded query. "exact" An exact match query.
Shorthand for "case-sensitive", "diacritic-sensitive",
"punctuation-sensitive", "whitespace-sensitive", "unstemmed", and
"unwildcarded". "lang=iso639code" Specifies the language of the
query. The iso639code code portion is case-insensitive, and uses
the languages specified by ISO 639. The default is specified in the
database configuration. "min-occurs=number" Specifies the minimum
number of occurrences required. If fewer that this number of words
occur, the fragment does not match. The default is 1.
"max-occurs=number" Specifies the maximum number of occurrences
required. If more than this number of words occur, the fragment
does not match. The default is unbounded. "synonym" Specifies that
all of the terms in the $text parameter are considered synonyms for
scoring purposes. The result is that occurrences of more than one
of the synonyms are scored as if there are more occurrences of the
same term (as opposed to having a separate term that contributes to
score). "lexicon-expansion-limit=number" Specifies the limit for
lexicon expansion. This puts a restriction on the number of lexicon
expansions that can be performed. If the limit is exceeded, the
server may raise an error depending on whether the "limit-check"
option is set. The default value for this option will be 4096.
"limit-check" Specifies that an error will be raised if the lexicon
expansion exceeds the specified limit. "no-limit-check" Specifies
that error will not be raised if the lexicon expansion exceeds the
specified limit. The server will try to resolve the wildcard. (of
xs:string)weight - A weight for this query. Higher weights
move search results up in the relevance order. The default is 1.0.
The weight should be between 64 and -16. Weights greater than 64
will have the same effect as a weight of 64. Weights less than the
absolute value of 0.0625 (between -0.0625 and 0.0625) are rounded
to 0, which means that they do not contribute to the score. (of
xs:double)CtsQueryExpr elementValueQuery(ServerExpression elementName, ServerExpression text, ServerExpression options, ServerExpression weight)
Provides a client interface to the cts:element-value-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)text - One or more element values to match. When
multiple strings are specified, the query matches if any string
matches. (of xs:string)options - Options to this query. The default is
(). Options include: "case-sensitive" A case-sensitive query.
"case-insensitive" A case-insensitive query. "diacritic-sensitive"
A diacritic-sensitive query. "diacritic-insensitive" A
diacritic-insensitive query. "punctuation-sensitive" A
punctuation-sensitive query. "punctuation-insensitive" A
punctuation-insensitive query. "whitespace-sensitive" A
whitespace-sensitive query. "whitespace-insensitive" A
whitespace-insensitive query. "stemmed" A stemmed query.
"unstemmed" An unstemmed query. "wildcarded" A wildcarded query.
"unwildcarded" An unwildcarded query. "exact" An exact match query.
Shorthand for "case-sensitive", "diacritic-sensitive",
"punctuation-sensitive", "whitespace-sensitive", "unstemmed", and
"unwildcarded". "lang=iso639code" Specifies the language of the
query. The iso639code code portion is case-insensitive, and uses
the languages specified by ISO 639. The default is specified in the
database configuration. "min-occurs=number" Specifies the minimum
number of occurrences required. If fewer that this number of words
occur, the fragment does not match. The default is 1.
"max-occurs=number" Specifies the maximum number of occurrences
required. If more than this number of words occur, the fragment
does not match. The default is unbounded. "synonym" Specifies that
all of the terms in the $text parameter are considered synonyms for
scoring purposes. The result is that occurrences of more than one
of the synonyms are scored as if there are more occurrences of the
same term (as opposed to having a separate term that contributes to
score). "lexicon-expansion-limit=number" Specifies the limit for
lexicon expansion. This puts a restriction on the number of lexicon
expansions that can be performed. If the limit is exceeded, the
server may raise an error depending on whether the "limit-check"
option is set. The default value for this option will be 4096.
"limit-check" Specifies that an error will be raised if the lexicon
expansion exceeds the specified limit. "no-limit-check" Specifies
that error will not be raised if the lexicon expansion exceeds the
specified limit. The server will try to resolve the wildcard. (of
xs:string)weight - A weight for this query. Higher weights
move search results up in the relevance order. The default is 1.0.
The weight should be between 64 and -16. Weights greater than 64
will have the same effect as a weight of 64. Weights less than the
absolute value of 0.0625 (between -0.0625 and 0.0625) are rounded
to 0, which means that they do not contribute to the score. (of
xs:double)CtsQueryExpr elementWordQuery(java.lang.String elementName, java.lang.String text)
Provides a client interface to the cts:element-word-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)text - Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches. (of xs:string)CtsQueryExpr elementWordQuery(ServerExpression elementName, ServerExpression text)
Provides a client interface to the cts:element-word-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)text - Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches. (of xs:string)CtsQueryExpr elementWordQuery(java.lang.String elementName, java.lang.String text, java.lang.String... options)
Provides a client interface to the cts:element-word-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)text - Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches. (of xs:string)options - Options to this query. The default is
(). Options include: "case-sensitive" A case-sensitive query.
"case-insensitive" A case-insensitive query. "diacritic-sensitive"
A diacritic-sensitive query. "diacritic-insensitive" A
diacritic-insensitive query. "punctuation-sensitive" A
punctuation-sensitive query. "punctuation-insensitive" A
punctuation-insensitive query. "whitespace-sensitive" A
whitespace-sensitive query. "whitespace-insensitive" A
whitespace-insensitive query. "stemmed" A stemmed query.
"unstemmed" An unstemmed query. "wildcarded" A wildcarded query.
"unwildcarded" An unwildcarded query. "exact" An exact match query.
Shorthand for "case-sensitive", "diacritic-sensitive",
"punctuation-sensitive", "whitespace-sensitive", "unstemmed", and
"unwildcarded". "lang=iso639code" Specifies the language of the
query. The iso639code code portion is case-insensitive, and uses
the languages specified by ISO 639. The default is specified in the
database configuration. "distance-weight=number" A weight applied
based on the minimum distance between matches of this query. Higher
weights add to the importance of proximity (as opposed to term
matches) when the relevance order is calculated. The default value
is 0.0 (no impact of proximity). The weight should be between 64
and -16. Weights greater than 64 will have the same effect as a
weight of 64. This parameter has no effect if the word positions
index is not enabled. This parameter has no effect on searches that
use score-simple, score-random, or score-zero (because those
scoring algorithms do not consider term frequency, proximity is
irrelevant). "min-occurs=number" Specifies the minimum number of
occurrences required. If fewer that this number of words occur, the
fragment does not match. The default is 1. "max-occurs=number"
Specifies the maximum number of occurrences required. If more than
this number of words occur, the fragment does not match. The
default is unbounded. "synonym" Specifies that all of the terms in
the $text parameter are considered synonyms for scoring purposes.
The result is that occurrences of more than one of the synonyms are
scored as if there are more occurrences of the same term (as
opposed to having a separate term that contributes to score).
"lexicon-expand=value" The value is one of full, prefix-postfix,
off, or heuristic (the default is heuristic). An option with a
value of lexicon-expand=full specifies that wildcards are resolved
by expanding the pattern to words in a lexicon (if there is one
available), and turning into a series of cts:word-queries, even if
this takes a long time to evaluate. An option with a value of
lexicon-expand=prefix-postfix specifies that wildcards are resolved
by expanding the pattern to the pre- and postfixes of the words in
the word lexicon (if there is one), and turning the query into a
series of character queries, even if it takes a long time to
evaluate. An option with a value of lexicon-expand=off specifies
that wildcards are only resolved by looking up character patterns
in the search pattern index, not in the lexicon. An option with a
value of lexicon-expand=heuristic, which is the default, specifies
that wildcards are resolved by using a series of internal rules,
such as estimating the number of lexicon entries that need to be
scanned, seeing if the estimate crosses certain thresholds, and (if
appropriate), using another way besides lexicon expansion to
resolve the query. * "lexicon-expansion-limit=number" Specifies the
limit for lexicon expansion. This puts a restriction on the number
of lexicon expansions that can be performed. If the limit is
exceeded, the server may raise an error depending on whether the
"limit-check" option is set. The default value for this option will
be 4096. "limit-check" Specifies that an error will be raised if
the lexicon expansion exceeds the specified limit. "no-limit-check"
Specifies that error will not be raised if the lexicon expansion
exceeds the specified limit. The server will try to resolve the
wildcard. (of xs:string)CtsQueryExpr elementWordQuery(ServerExpression elementName, ServerExpression text, ServerExpression options)
Provides a client interface to the cts:element-word-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)text - Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches. (of xs:string)options - Options to this query. The default is
(). Options include: "case-sensitive" A case-sensitive query.
"case-insensitive" A case-insensitive query. "diacritic-sensitive"
A diacritic-sensitive query. "diacritic-insensitive" A
diacritic-insensitive query. "punctuation-sensitive" A
punctuation-sensitive query. "punctuation-insensitive" A
punctuation-insensitive query. "whitespace-sensitive" A
whitespace-sensitive query. "whitespace-insensitive" A
whitespace-insensitive query. "stemmed" A stemmed query.
"unstemmed" An unstemmed query. "wildcarded" A wildcarded query.
"unwildcarded" An unwildcarded query. "exact" An exact match query.
Shorthand for "case-sensitive", "diacritic-sensitive",
"punctuation-sensitive", "whitespace-sensitive", "unstemmed", and
"unwildcarded". "lang=iso639code" Specifies the language of the
query. The iso639code code portion is case-insensitive, and uses
the languages specified by ISO 639. The default is specified in the
database configuration. "distance-weight=number" A weight applied
based on the minimum distance between matches of this query. Higher
weights add to the importance of proximity (as opposed to term
matches) when the relevance order is calculated. The default value
is 0.0 (no impact of proximity). The weight should be between 64
and -16. Weights greater than 64 will have the same effect as a
weight of 64. This parameter has no effect if the word positions
index is not enabled. This parameter has no effect on searches that
use score-simple, score-random, or score-zero (because those
scoring algorithms do not consider term frequency, proximity is
irrelevant). "min-occurs=number" Specifies the minimum number of
occurrences required. If fewer that this number of words occur, the
fragment does not match. The default is 1. "max-occurs=number"
Specifies the maximum number of occurrences required. If more than
this number of words occur, the fragment does not match. The
default is unbounded. "synonym" Specifies that all of the terms in
the $text parameter are considered synonyms for scoring purposes.
The result is that occurrences of more than one of the synonyms are
scored as if there are more occurrences of the same term (as
opposed to having a separate term that contributes to score).
"lexicon-expand=value" The value is one of full, prefix-postfix,
off, or heuristic (the default is heuristic). An option with a
value of lexicon-expand=full specifies that wildcards are resolved
by expanding the pattern to words in a lexicon (if there is one
available), and turning into a series of cts:word-queries, even if
this takes a long time to evaluate. An option with a value of
lexicon-expand=prefix-postfix specifies that wildcards are resolved
by expanding the pattern to the pre- and postfixes of the words in
the word lexicon (if there is one), and turning the query into a
series of character queries, even if it takes a long time to
evaluate. An option with a value of lexicon-expand=off specifies
that wildcards are only resolved by looking up character patterns
in the search pattern index, not in the lexicon. An option with a
value of lexicon-expand=heuristic, which is the default, specifies
that wildcards are resolved by using a series of internal rules,
such as estimating the number of lexicon entries that need to be
scanned, seeing if the estimate crosses certain thresholds, and (if
appropriate), using another way besides lexicon expansion to
resolve the query. * "lexicon-expansion-limit=number" Specifies the
limit for lexicon expansion. This puts a restriction on the number
of lexicon expansions that can be performed. If the limit is
exceeded, the server may raise an error depending on whether the
"limit-check" option is set. The default value for this option will
be 4096. "limit-check" Specifies that an error will be raised if
the lexicon expansion exceeds the specified limit. "no-limit-check"
Specifies that error will not be raised if the lexicon expansion
exceeds the specified limit. The server will try to resolve the
wildcard. (of xs:string)CtsQueryExpr elementWordQuery(java.lang.String elementName, java.lang.String text, java.lang.String options, double weight)
Provides a client interface to the cts:element-word-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)text - Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches. (of xs:string)options - Options to this query. The default is
(). Options include: "case-sensitive" A case-sensitive query.
"case-insensitive" A case-insensitive query. "diacritic-sensitive"
A diacritic-sensitive query. "diacritic-insensitive" A
diacritic-insensitive query. "punctuation-sensitive" A
punctuation-sensitive query. "punctuation-insensitive" A
punctuation-insensitive query. "whitespace-sensitive" A
whitespace-sensitive query. "whitespace-insensitive" A
whitespace-insensitive query. "stemmed" A stemmed query.
"unstemmed" An unstemmed query. "wildcarded" A wildcarded query.
"unwildcarded" An unwildcarded query. "exact" An exact match query.
Shorthand for "case-sensitive", "diacritic-sensitive",
"punctuation-sensitive", "whitespace-sensitive", "unstemmed", and
"unwildcarded". "lang=iso639code" Specifies the language of the
query. The iso639code code portion is case-insensitive, and uses
the languages specified by ISO 639. The default is specified in the
database configuration. "distance-weight=number" A weight applied
based on the minimum distance between matches of this query. Higher
weights add to the importance of proximity (as opposed to term
matches) when the relevance order is calculated. The default value
is 0.0 (no impact of proximity). The weight should be between 64
and -16. Weights greater than 64 will have the same effect as a
weight of 64. This parameter has no effect if the word positions
index is not enabled. This parameter has no effect on searches that
use score-simple, score-random, or score-zero (because those
scoring algorithms do not consider term frequency, proximity is
irrelevant). "min-occurs=number" Specifies the minimum number of
occurrences required. If fewer that this number of words occur, the
fragment does not match. The default is 1. "max-occurs=number"
Specifies the maximum number of occurrences required. If more than
this number of words occur, the fragment does not match. The
default is unbounded. "synonym" Specifies that all of the terms in
the $text parameter are considered synonyms for scoring purposes.
The result is that occurrences of more than one of the synonyms are
scored as if there are more occurrences of the same term (as
opposed to having a separate term that contributes to score).
"lexicon-expand=value" The value is one of full, prefix-postfix,
off, or heuristic (the default is heuristic). An option with a
value of lexicon-expand=full specifies that wildcards are resolved
by expanding the pattern to words in a lexicon (if there is one
available), and turning into a series of cts:word-queries, even if
this takes a long time to evaluate. An option with a value of
lexicon-expand=prefix-postfix specifies that wildcards are resolved
by expanding the pattern to the pre- and postfixes of the words in
the word lexicon (if there is one), and turning the query into a
series of character queries, even if it takes a long time to
evaluate. An option with a value of lexicon-expand=off specifies
that wildcards are only resolved by looking up character patterns
in the search pattern index, not in the lexicon. An option with a
value of lexicon-expand=heuristic, which is the default, specifies
that wildcards are resolved by using a series of internal rules,
such as estimating the number of lexicon entries that need to be
scanned, seeing if the estimate crosses certain thresholds, and (if
appropriate), using another way besides lexicon expansion to
resolve the query. * "lexicon-expansion-limit=number" Specifies the
limit for lexicon expansion. This puts a restriction on the number
of lexicon expansions that can be performed. If the limit is
exceeded, the server may raise an error depending on whether the
"limit-check" option is set. The default value for this option will
be 4096. "limit-check" Specifies that an error will be raised if
the lexicon expansion exceeds the specified limit. "no-limit-check"
Specifies that error will not be raised if the lexicon expansion
exceeds the specified limit. The server will try to resolve the
wildcard. (of xs:string)weight - A weight for this query. Higher weights
move search results up in the relevance order. The default is 1.0.
The weight should be between 64 and -16. Weights greater than 64
will have the same effect as a weight of 64. Weights less than the
absolute value of 0.0625 (between -0.0625 and 0.0625) are rounded
to 0, which means that they do not contribute to the score. (of
xs:double)CtsQueryExpr elementWordQuery(ServerExpression elementName, ServerExpression text, ServerExpression options, ServerExpression weight)
Provides a client interface to the cts:element-word-query server function.
elementName - One or more element QNames to match.
When multiple QNames are specified, the query matches if any QName
matches. (of xs:QName)text - Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches. (of xs:string)options - Options to this query. The default is
(). Options include: "case-sensitive" A case-sensitive query.
"case-insensitive" A case-insensitive query. "diacritic-sensitive"
A diacritic-sensitive query. "diacritic-insensitive" A
diacritic-insensitive query. "punctuation-sensitive" A
punctuation-sensitive query. "punctuation-insensitive" A
punctuation-insensitive query. "whitespace-sensitive" A
whitespace-sensitive query. "whitespace-insensitive" A
whitespace-insensitive query. "stemmed" A stemmed query.
"unstemmed" An unstemmed query. "wildcarded" A wildcarded query.
"unwildcarded" An unwildcarded query. "exact" An exact match query.
Shorthand for "case-sensitive", "diacritic-sensitive",
"punctuation-sensitive", "whitespace-sensitive", "unstemmed", and
"unwildcarded". "lang=iso639code" Specifies the language of the
query. The iso639code code portion is case-insensitive, and uses
the languages specified by ISO 639. The default is specified in the
database configuration. "distance-weight=number" A weight applied
based on the minimum distance between matches of this query. Higher
weights add to the importance of proximity (as opposed to term
matches) when the relevance order is calculated. The default value
is 0.0 (no impact of proximity). The weight should be between 64
and -16. Weights greater than 64 will have the same effect as a
weight of 64. This parameter has no effect if the word positions
index is not enabled. This parameter has no effect on searches that
use score-simple, score-random, or score-zero (because those
scoring algorithms do not consider term frequency, proximity is
irrelevant). "min-occurs=number" Specifies the minimum number of
occurrences required. If fewer that this number of words occur, the
fragment does not match. The default is 1. "max-occurs=number"
Specifies the maximum number of occurrences required. If more than
this number of words occur, the fragment does not match. The
default is unbounded. "synonym" Specifies that all of the terms in
the $text parameter are considered synonyms for scoring purposes.
The result is that occurrences of more than one of the synonyms are
scored as if there are more occurrences of the same term (as
opposed to having a separate term that contributes to score).
"lexicon-expand=value" The value is one of full, prefix-postfix,
off, or heuristic (the default is heuristic). An option with a
value of lexicon-expand=full specifies that wildcards are resolved
by expanding the pattern to words in a lexicon (if there is one
available), and turning into a series of cts:word-queries, even if
this takes a long time to evaluate. An option with a value of
lexicon-expand=prefix-postfix specifies that wildcards are resolved
by expanding the pattern to the pre- and postfixes of the words in
the word lexicon (if there is one), and turning the query into a
series of character queries, even if it takes a long time to
evaluate. An option with a value of lexicon-expand=off specifies
that wildcards are only resolved by looking up character patterns
in the search pattern index, not in the lexicon. An option with a
value of lexicon-expand=heuristic, which is the default, specifies
that wildcards are resolved by using a series of internal rules,
such as estimating the number of lexicon entries that need to be
scanned, seeing if the estimate crosses certain thresholds, and (if
appropriate), using another way besides lexicon expansion to
resolve the query. * "lexicon-expansion-limit=number" Specifies the
limit for lexicon expansion. This puts a restriction on the number
of lexicon expansions that can be performed. If the limit is
exceeded, the server may raise an error depending on whether the
"limit-check" option is set. The default value for this option will
be 4096. "limit-check" Specifies that an error will be raised if
the lexicon expansion exceeds the specified limit. "no-limit-check"
Specifies that error will not be raised if the lexicon expansion
exceeds the specified limit. The server will try to resolve the
wildcard. (of xs:string)weight - A weight for this query. Higher weights
move search results up in the relevance order. The default is 1.0.
The weight should be between 64 and -16. Weights greater than 64
will have the same effect as a weight of 64. Weights less than the
absolute value of 0.0625 (between -0.0625 and 0.0625) are rounded
to 0, which means that they do not contribute to the score. (of
xs:double)CtsQueryExpr falseQuery()
Provides a client interface to the cts:false-query server function.
CtsQueryExpr fieldRangeQuery(java.lang.String fieldName, java.lang.String operator, java.lang.String value)
Provides a client interface to the cts:field-range-query server function.
fieldName - One or more field names to match. When
multiple field names are specified, the query matches if any field
name matches. (of xs:string)operator - A comparison operator. Operators
include: "<" Match range index values less than $value. "<="
Match range index values less than or equal to $value. ">" Match
range index values greater than $value. ">=" Match range index
values greater than or equal to $value. "=" Match range index
values equal to $value. "!=" Match range index values not equal to
$value. (of xs:string)value - One or more field values to match. When
multiple values are specified, the query matches if any value
matches. The value must be a type for which there is a range index
defined. (of xs:anyAtomicType)CtsQueryExpr fieldRangeQuery(ServerExpression fieldName, ServerExpression operator, ServerExpression value)
Provides a client interface to the cts:field-range-query server function.
fieldName - One or more field names to match. When
multiple field names are specified, the query matches if any field
name matches. (of xs:string)operator - A comparison operator. Operators
include: "<" Match range index values less than $value. "<="
Match range index values less than or equal to $value. ">" Match
range index values greater than $value. ">=" Match range index
values greater than or equal to $value. "=" Match range index
values equal to $value. "!=" Match range index values not equal to
$value. (of xs:string)value - One or more field values to match. When
multiple values are specified, the query matches if any value
matches. The value must be a type for which there is a range index
defined. (of xs:anyAtomicType)CtsQueryExpr fieldRangeQuery(java.lang.String fieldName, java.lang.String operator, java.lang.String value, java.lang.String... options)
Provides a client interface to the cts:field-range-query server function.
fieldName - One or more field names to match. When
multiple field names are specified, the query matches if any field
name matches. (of xs:string)operator - A comparison operator. Operators
include: "<" Match range index values less than $value. "<="
Match range index values less than or equal to $value. ">" Match
range index values greater than $value. ">=" Match range index
values greater than or equal to $value. "=" Match range index
values equal to $value. "!=" Match range index values not equal to
$value. (of xs:string)value - One or more field values to match. When
multiple values are specified, the query matches if any value
matches. The value must be a type for which there is a range index
defined. (of xs:anyAtomicType)options - Options to this query. The default is
(). Options include: "collation=URI" Use the range index with the
collation specified by URI. If not specified, then the default
collation from the query is used. If a range index with the
specified collation does not exist, an error is thrown. "cached"
Cache the results of this query in the list cache. "uncached" Do
not cache the results of this query in the list cache.
"cached-incremental" When querying on a short date or dateTime
range, break the query into sub-queries on smaller ranges, and then
cache the results of each. See the Usage Notes for details.
"min-occurs=number" Specifies the minimum number of occurrences
required. If fewer that this number of words occur, the fragment
does not match. The default is 1. "max-occurs=number" Specifies the
maximum number of occurrences required. If more than this number of
words occur, the fragment does not match. The default is unbounded.
"score-function=function" Use the selected scoring function. The
score function may be: linearUse a linear function of the
difference between the specified query value and the matching value
in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $value parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrences of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)CtsQueryExpr fieldRangeQuery(ServerExpression fieldName, ServerExpression operator, ServerExpression value, ServerExpression options)
Provides a client interface to the cts:field-range-query server function.
fieldName - One or more field names to match. When
multiple field names are specified, the query matches if any field
name matches. (of xs:string)operator - A comparison operator. Operators
include: "<" Match range index values less than $value. "<="
Match range index values less than or equal to $value. ">" Match
range index values greater than $value. ">=" Match range index
values greater than or equal to $value. "=" Match range index
values equal to $value. "!=" Match range index values not equal to
$value. (of xs:string)value - One or more field values to match. When
multiple values are specified, the query matches if any value
matches. The value must be a type for which there is a range index
defined. (of xs:anyAtomicType)options - Options to this query. The default is
(). Options include: "collation=URI" Use the range index with the
collation specified by URI. If not specified, then the default
collation from the query is used. If a range index with the
specified collation does not exist, an error is thrown. "cached"
Cache the results of this query in the list cache. "uncached" Do
not cache the results of this query in the list cache.
"cached-incremental" When querying on a short date or dateTime
range, break the query into sub-queries on smaller ranges, and then
cache the results of each. See the Usage Notes for details.
"min-occurs=number" Specifies the minimum number of occurrences
required. If fewer that this number of words occur, the fragment
does not match. The default is 1. "max-occurs=number" Specifies the
maximum number of occurrences required. If more than this number of
words occur, the fragment does not match. The default is unbounded.
"score-function=function" Use the selected scoring function. The
score function may be: linearUse a linear function of the
difference between the specified query value and the matching value
in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $value parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrences of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)CtsQueryExpr fieldRangeQuery(java.lang.String fieldName, java.lang.String operator, java.lang.String value, java.lang.String options, double weight)
Provides a client interface to the cts:field-range-query server function.
fieldName - One or more field names to match. When
multiple field names are specified, the query matches if any field
name matches. (of xs:string)operator - A comparison operator. Operators
include: "<" Match range index values less than $value. "<="
Match range index values less than or equal to $value. ">" Match
range index values greater than $value. ">=" Match range index
values greater than or equal to $value. "=" Match range index
values equal to $value. "!=" Match range index values not equal to
$value. (of xs:string)value - One or more field values to match. When
multiple values are specified, the query matches if any value
matches. The value must be a type for which there is a range index
defined. (of xs:anyAtomicType)options - Options to this query. The default is
(). Options include: "collation=URI" Use the range index with the
collation specified by URI. If not specified, then the default
collation from the query is used. If a range index with the
specified collation does not exist, an error is thrown. "cached"
Cache the results of this query in the list cache. "uncached" Do
not cache the results of this query in the list cache.
"cached-incremental" When querying on a short date or dateTime
range, break the query into sub-queries on smaller ranges, and then
cache the results of each. See the Usage Notes for details.
"min-occurs=number" Specifies the minimum number of occurrences
required. If fewer that this number of words occur, the fragment
does not match. The default is 1. "max-occurs=number" Specifies the
maximum number of occurrences required. If more than this number of
words occur, the fragment does not match. The default is unbounded.
"score-function=function" Use the selected scoring function. The
score function may be: linearUse a linear function of the
difference between the specified query value and the matching value
in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $value parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrences of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)weight - A weight for this query. The default is
1.0. (of xs:double)CtsQueryExpr fieldRangeQuery(ServerExpression fieldName, ServerExpression operator, ServerExpression value, ServerExpression options, ServerExpression weight)
Provides a client interface to the cts:field-range-query server function.
fieldName - One or more field names to match. When
multiple field names are specified, the query matches if any field
name matches. (of xs:string)operator - A comparison operator. Operators
include: "<" Match range index values less than $value. "<="
Match range index values less than or equal to $value. ">" Match
range index values greater than $value. ">=" Match range index
values greater than or equal to $value. "=" Match range index
values equal to $value. "!=" Match range index values not equal to
$value. (of xs:string)value - One or more field values to match. When
multiple values are specified, the query matches if any value
matches. The value must be a type for which there is a range index
defined. (of xs:anyAtomicType)options - Options to this query. The default is
(). Options include: "collation=URI" Use the range index with the
collation specified by URI. If not specified, then the default
collation from the query is used. If a range index with the
specified collation does not exist, an error is thrown. "cached"
Cache the results of this query in the list cache. "uncached" Do
not cache the results of this query in the list cache.
"cached-incremental" When querying on a short date or dateTime
range, break the query into sub-queries on smaller ranges, and then
cache the results of each. See the Usage Notes for details.
"min-occurs=number" Specifies the minimum number of occurrences
required. If fewer that this number of words occur, the fragment
does not match. The default is 1. "max-occurs=number" Specifies the
maximum number of occurrences required. If more than this number of
words occur, the fragment does not match. The default is unbounded.
"score-function=function" Use the selected scoring function. The
score function may be: linearUse a linear function of the
difference between the specified query value and the matching value
in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $value parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrences of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)weight - A weight for this query. The default is
1.0. (of xs:double)CtsReferenceExpr fieldReference(java.lang.String field)
Provides a client interface to the cts:field-reference server function.
field - A field name. (of xs:string)CtsReferenceExpr fieldReference(ServerExpression field)
Provides a client interface to the cts:field-reference server function.
field - A field name. (of xs:string)CtsReferenceExpr fieldReference(java.lang.String field, java.lang.String options)
Provides a client interface to the cts:field-reference server function.
field - A field name. (of xs:string)options - Options. The default is (). Options
include: "type=type" Use the lexicon with the type specified by
type (int, unsignedInt, long, unsignedLong, float, double, decimal,
dateTime, time, date, gYearMonth, gYear, gMonth, gDay,
yearMonthDuration, dayTimeDuration, string, anyURI, point, or
long-lat-point) "collation=URI" Use the lexicon with the collation
specified by URI. "nullable" Allow null values in tuples reported
from cts:value-tuples when using this lexicon. "unchecked" Read the
scalar type, collation and coordinate-system info only from the
input. Do not check the definition against the context database.
"coordinate-system=name" Create a reference to an index or lexicon
based on the specified coordinate system. Allowed values: "wgs84",
"wgs84/double", "raw", "raw/double". Only applicable if the
index/lexicon value type is point or long-lat-point.
"precision=value" Create a reference to an index or lexicon
configured with the specified geospatial precision. Allowed values:
float and double. Only applicable if the index/lexicon value type
is point or long-lat-point. This value takes precedence over the
precision implicit in the coordinate system name. (of xs:string)CtsReferenceExpr fieldReference(ServerExpression field, ServerExpression options)
Provides a client interface to the cts:field-reference server function.
field - A field name. (of xs:string)options - Options. The default is (). Options
include: "type=type" Use the lexicon with the type specified by
type (int, unsignedInt, long, unsignedLong, float, double, decimal,
dateTime, time, date, gYearMonth, gYear, gMonth, gDay,
yearMonthDuration, dayTimeDuration, string, anyURI, point, or
long-lat-point) "collation=URI" Use the lexicon with the collation
specified by URI. "nullable" Allow null values in tuples reported
from cts:value-tuples when using this lexicon. "unchecked" Read the
scalar type, collation and coordinate-system info only from the
input. Do not check the definition against the context database.
"coordinate-system=name" Create a reference to an index or lexicon
based on the specified coordinate system. Allowed values: "wgs84",
"wgs84/double", "raw", "raw/double". Only applicable if the
index/lexicon value type is point or long-lat-point.
"precision=value" Create a reference to an index or lexicon
configured with the specified geospatial precision. Allowed values:
float and double. Only applicable if the index/lexicon value type
is point or long-lat-point. This value takes precedence over the
precision implicit in the coordinate system name. (of xs:string)CtsQueryExpr fieldValueQuery(java.lang.String fieldName, java.lang.String text)
Provides a client interface to the cts:field-value-query server function.
fieldName - One or more field names to search
over. If multiple field names are supplied, the match can be in any
of the specified fields (or-query semantics). (of xs:string)text - The values to match. If multiple values are
specified, the query matches if any of the values match (or-query
semantics). For XML and metadata, the values should be strings. For
JSON, the values can be strings, numbers or booleans to match
correspondingly typed nodes. To match null, pass in the empty
sequence. (of xs:anyAtomicType)CtsQueryExpr fieldValueQuery(ServerExpression fieldName, ServerExpression text)
Provides a client interface to the cts:field-value-query server function.
fieldName - One or more field names to search
over. If multiple field names are supplied, the match can be in any
of the specified fields (or-query semantics). (of xs:string)text - The values to match. If multiple values are
specified, the query matches if any of the values match (or-query
semantics). For XML and metadata, the values should be strings. For
JSON, the values can be strings, numbers or booleans to match
correspondingly typed nodes. To match null, pass in the empty
sequence. (of xs:anyAtomicType)CtsQueryExpr fieldValueQuery(java.lang.String fieldName, java.lang.String text, java.lang.String... options)
Provides a client interface to the cts:field-value-query server function.
fieldName - One or more field names to search
over. If multiple field names are supplied, the match can be in any
of the specified fields (or-query semantics). (of xs:string)text - The values to match. If multiple values are
specified, the query matches if any of the values match (or-query
semantics). For XML and metadata, the values should be strings. For
JSON, the values can be strings, numbers or booleans to match
correspondingly typed nodes. To match null, pass in the empty
sequence. (of xs:anyAtomicType)options - Options to this query. The default is
(). Options include: "case-sensitive" A case-sensitive query.
"case-insensitive" A case-insensitive query. "diacritic-sensitive"
A diacritic-sensitive query. "diacritic-insensitive" A
diacritic-insensitive query. "punctuation-sensitive" A
punctuation-sensitive query. "punctuation-insensitive" A
punctuation-insensitive query. "whitespace-sensitive" A
whitespace-sensitive query. "whitespace-insensitive" A
whitespace-insensitive query. "stemmed" A stemmed query.
"unstemmed" An unstemmed query. "wildcarded" A wildcarded query.
"unwildcarded" An unwildcarded query. "exact" An exact match query.
Shorthand for "case-sensitive", "diacritic-sensitive",
"punctuation-sensitive", "whitespace-sensitive", "unstemmed", and
"unwildcarded". "lang=iso639code" Specifies the language of the
query. The iso639code code portion is case-insensitive, and uses
the languages specified by ISO 639. The default is specified in the
database configuration. "distance-weight=number" A weight applied
based on the minimum distance between matches of this query. Higher
weights add to the importance of proximity (as opposed to term
matches) when the relevance order is calculated. The default value
is 0.0 (no impact of proximity). The weight should be between 64
and -16. Weights greater than 64 will have the same effect as a
weight of 64. This parameter has no effect if the word positions
index is not enabled. This parameter has no effect on searches that
use score-simple or score-random (because those scoring algorithms
do not consider term frequency, proximity is irrelevant).
"min-occurs=number" Specifies the minimum number of occurrences
required. If fewer that this number of words occur, the fragment
does not match. The default is 1. "max-occurs=number" Specifies the
maximum number of occurrences required. If more than this number of
words occur, the fragment does not match. The default is unbounded.
"synonym" Specifies that all of the terms in the $text parameter
are considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrences of the same term (as opposed to having a
separate term that contributes to score).
"lexicon-expansion-limit=number" Specifies the limit for lexicon
expansion. This puts a restriction on the number of lexicon
expansions that can be performed. If the limit is exceeded, the
server may raise an error depending on whether the "limit-check"
option is set. The default value for this option will be 4096.
"limit-check" Specifies that an error will be raised if the lexicon
expansion exceeds the specified limit. "no-limit-check" Specifies
that error will not be raised if the lexicon expansion exceeds the
specified limit. The server will try to resolve the wildcard. (of
xs:string)CtsQueryExpr fieldValueQuery(ServerExpression fieldName, ServerExpression text, ServerExpression options)
Provides a client interface to the cts:field-value-query server function.
fieldName - One or more field names to search
over. If multiple field names are supplied, the match can be in any
of the specified fields (or-query semantics). (of xs:string)text - The values to match. If multiple values are
specified, the query matches if any of the values match (or-query
semantics). For XML and metadata, the values should be strings. For
JSON, the values can be strings, numbers or booleans to match
correspondingly typed nodes. To match null, pass in the empty
sequence. (of xs:anyAtomicType)options - Options to this query. The default is
(). Options include: "case-sensitive" A case-sensitive query.
"case-insensitive" A case-insensitive query. "diacritic-sensitive"
A diacritic-sensitive query. "diacritic-insensitive" A
diacritic-insensitive query. "punctuation-sensitive" A
punctuation-sensitive query. "punctuation-insensitive" A
punctuation-insensitive query. "whitespace-sensitive" A
whitespace-sensitive query. "whitespace-insensitive" A
whitespace-insensitive query. "stemmed" A stemmed query.
"unstemmed" An unstemmed query. "wildcarded" A wildcarded query.
"unwildcarded" An unwildcarded query. "exact" An exact match query.
Shorthand for "case-sensitive", "diacritic-sensitive",
"punctuation-sensitive", "whitespace-sensitive", "unstemmed", and
"unwildcarded". "lang=iso639code" Specifies the language of the
query. The iso639code code portion is case-insensitive, and uses
the languages specified by ISO 639. The default is specified in the
database configuration. "distance-weight=number" A weight applied
based on the minimum distance between matches of this query. Higher
weights add to the importance of proximity (as opposed to term
matches) when the relevance order is calculated. The default value
is 0.0 (no impact of proximity). The weight should be between 64
and -16. Weights greater than 64 will have the same effect as a
weight of 64. This parameter has no effect if the word positions
index is not enabled. This parameter has no effect on searches that
use score-simple or score-random (because those scoring algorithms
do not consider term frequency, proximity is irrelevant).
"min-occurs=number" Specifies the minimum number of occurrences
required. If fewer that this number of words occur, the fragment
does not match. The default is 1. "max-occurs=number" Specifies the
maximum number of occurrences required. If more than this number of
words occur, the fragment does not match. The default is unbounded.
"synonym" Specifies that all of the terms in the $text parameter
are considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrences of the same term (as opposed to having a
separate term that contributes to score).
"lexicon-expansion-limit=number" Specifies the limit for lexicon
expansion. This puts a restriction on the number of lexicon
expansions that can be performed. If the limit is exceeded, the
server may raise an error depending on whether the "limit-check"
option is set. The default value for this option will be 4096.
"limit-check" Specifies that an error will be raised if the lexicon
expansion exceeds the specified limit. "no-limit-check" Specifies
that error will not be raised if the lexicon expansion exceeds the
specified limit. The server will try to resolve the wildcard. (of
xs:string)CtsQueryExpr fieldValueQuery(java.lang.String fieldName, java.lang.String text, java.lang.String options, double weight)
Provides a client interface to the cts:field-value-query server function.
fieldName - One or more field names to search
over. If multiple field names are supplied, the match can be in any
of the specified fields (or-query semantics). (of xs:string)text - The values to match. If multiple values are
specified, the query matches if any of the values match (or-query
semantics). For XML and metadata, the values should be strings. For
JSON, the values can be strings, numbers or booleans to match
correspondingly typed nodes. To match null, pass in the empty
sequence. (of xs:anyAtomicType)options - Options to this query. The default is
(). Options include: "case-sensitive" A case-sensitive query.
"case-insensitive" A case-insensitive query. "diacritic-sensitive"
A diacritic-sensitive query. "diacritic-insensitive" A
diacritic-insensitive query. "punctuation-sensitive" A
punctuation-sensitive query. "punctuation-insensitive" A
punctuation-insensitive query. "whitespace-sensitive" A
whitespace-sensitive query. "whitespace-insensitive" A
whitespace-insensitive query. "stemmed" A stemmed query.
"unstemmed" An unstemmed query. "wildcarded" A wildcarded query.
"unwildcarded" An unwildcarded query. "exact" An exact match query.
Shorthand for "case-sensitive", "diacritic-sensitive",
"punctuation-sensitive", "whitespace-sensitive", "unstemmed", and
"unwildcarded". "lang=iso639code" Specifies the language of the
query. The iso639code code portion is case-insensitive, and uses
the languages specified by ISO 639. The default is specified in the
database configuration. "distance-weight=number" A weight applied
based on the minimum distance between matches of this query. Higher
weights add to the importance of proximity (as opposed to term
matches) when the relevance order is calculated. The default value
is 0.0 (no impact of proximity). The weight should be between 64
and -16. Weights greater than 64 will have the same effect as a
weight of 64. This parameter has no effect if the word positions
index is not enabled. This parameter has no effect on searches that
use score-simple or score-random (because those scoring algorithms
do not consider term frequency, proximity is irrelevant).
"min-occurs=number" Specifies the minimum number of occurrences
required. If fewer that this number of words occur, the fragment
does not match. The default is 1. "max-occurs=number" Specifies the
maximum number of occurrences required. If more than this number of
words occur, the fragment does not match. The default is unbounded.
"synonym" Specifies that all of the terms in the $text parameter
are considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrences of the same term (as opposed to having a
separate term that contributes to score).
"lexicon-expansion-limit=number" Specifies the limit for lexicon
expansion. This puts a restriction on the number of lexicon
expansions that can be performed. If the limit is exceeded, the
server may raise an error depending on whether the "limit-check"
option is set. The default value for this option will be 4096.
"limit-check" Specifies that an error will be raised if the lexicon
expansion exceeds the specified limit. "no-limit-check" Specifies
that error will not be raised if the lexicon expansion exceeds the
specified limit. The server will try to resolve the wildcard. (of
xs:string)weight - A weight for this query. Higher weights
move search results up in the relevance order. The default is 1.0.
The weight should be between 64 and -16. Weights greater than 64
will have the same effect as a weight of 64. Weights less than the
absolute value of 0.0625 (between -0.0625 and 0.0625) are rounded
to 0, which means that they do not contribute to the score. (of
xs:double)CtsQueryExpr fieldValueQuery(ServerExpression fieldName, ServerExpression text, ServerExpression options, ServerExpression weight)
Provides a client interface to the cts:field-value-query server function.
fieldName - One or more field names to search
over. If multiple field names are supplied, the match can be in any
of the specified fields (or-query semantics). (of xs:string)text - The values to match. If multiple values are
specified, the query matches if any of the values match (or-query
semantics). For XML and metadata, the values should be strings. For
JSON, the values can be strings, numbers or booleans to match
correspondingly typed nodes. To match null, pass in the empty
sequence. (of xs:anyAtomicType)options - Options to this query. The default is
(). Options include: "case-sensitive" A case-sensitive query.
"case-insensitive" A case-insensitive query. "diacritic-sensitive"
A diacritic-sensitive query. "diacritic-insensitive" A
diacritic-insensitive query. "punctuation-sensitive" A
punctuation-sensitive query. "punctuation-insensitive" A
punctuation-insensitive query. "whitespace-sensitive" A
whitespace-sensitive query. "whitespace-insensitive" A
whitespace-insensitive query. "stemmed" A stemmed query.
"unstemmed" An unstemmed query. "wildcarded" A wildcarded query.
"unwildcarded" An unwildcarded query. "exact" An exact match query.
Shorthand for "case-sensitive", "diacritic-sensitive",
"punctuation-sensitive", "whitespace-sensitive", "unstemmed", and
"unwildcarded". "lang=iso639code" Specifies the language of the
query. The iso639code code portion is case-insensitive, and uses
the languages specified by ISO 639. The default is specified in the
database configuration. "distance-weight=number" A weight applied
based on the minimum distance between matches of this query. Higher
weights add to the importance of proximity (as opposed to term
matches) when the relevance order is calculated. The default value
is 0.0 (no impact of proximity). The weight should be between 64
and -16. Weights greater than 64 will have the same effect as a
weight of 64. This parameter has no effect if the word positions
index is not enabled. This parameter has no effect on searches that
use score-simple or score-random (because those scoring algorithms
do not consider term frequency, proximity is irrelevant).
"min-occurs=number" Specifies the minimum number of occurrences
required. If fewer that this number of words occur, the fragment
does not match. The default is 1. "max-occurs=number" Specifies the
maximum number of occurrences required. If more than this number of
words occur, the fragment does not match. The default is unbounded.
"synonym" Specifies that all of the terms in the $text parameter
are considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrences of the same term (as opposed to having a
separate term that contributes to score).
"lexicon-expansion-limit=number" Specifies the limit for lexicon
expansion. This puts a restriction on the number of lexicon
expansions that can be performed. If the limit is exceeded, the
server may raise an error depending on whether the "limit-check"
option is set. The default value for this option will be 4096.
"limit-check" Specifies that an error will be raised if the lexicon
expansion exceeds the specified limit. "no-limit-check" Specifies
that error will not be raised if the lexicon expansion exceeds the
specified limit. The server will try to resolve the wildcard. (of
xs:string)weight - A weight for this query. Higher weights
move search results up in the relevance order. The default is 1.0.
The weight should be between 64 and -16. Weights greater than 64
will have the same effect as a weight of 64. Weights less than the
absolute value of 0.0625 (between -0.0625 and 0.0625) are rounded
to 0, which means that they do not contribute to the score. (of
xs:double)CtsQueryExpr fieldWordQuery(java.lang.String fieldName, java.lang.String text)
Provides a client interface to the cts:field-word-query server function.
fieldName - One or more field names to search
over. If multiple field names are supplied, the match can be in any
of the specified fields (or-query semantics). (of xs:string)text - The word or phrase to match. If multiple
strings are specified, the query matches if any of the words or
phrases match (or-query semantics). (of xs:string)CtsQueryExpr fieldWordQuery(ServerExpression fieldName, ServerExpression text)
Provides a client interface to the cts:field-word-query server function.
fieldName - One or more field names to search
over. If multiple field names are supplied, the match can be in any
of the specified fields (or-query semantics). (of xs:string)text - The word or phrase to match. If multiple
strings are specified, the query matches if any of the words or
phrases match (or-query semantics). (of xs:string)CtsQueryExpr fieldWordQuery(java.lang.String fieldName, java.lang.String text, java.lang.String... options)
Provides a client interface to the cts:field-word-query server function.
fieldName - One or more field names to search
over. If multiple field names are supplied, the match can be in any
of the specified fields (or-query semantics). (of xs:string)text - The word or phrase to match. If multiple
strings are specified, the query matches if any of the words or
phrases match (or-query semantics). (of xs:string)options - Options to this query. The default is
(). Options include: "case-sensitive" A case-sensitive query.
"case-insensitive" A case-insensitive query. "diacritic-sensitive"
A diacritic-sensitive query. "diacritic-insensitive" A
diacritic-insensitive query. "punctuation-sensitive" A
punctuation-sensitive query. "punctuation-insensitive" A
punctuation-insensitive query. "whitespace-sensitive" A
whitespace-sensitive query. "whitespace-insensitive" A
whitespace-insensitive query. "stemmed" A stemmed query.
"unstemmed" An unstemmed query. "wildcarded" A wildcarded query.
"unwildcarded" An unwildcarded query. "exact" An exact match query.
Shorthand for "case-sensitive", "diacritic-sensitive",
"punctuation-sensitive", "whitespace-sensitive", "unstemmed", and
"unwildcarded". "lang=iso639code" Specifies the language of the
query. The iso639code code portion is case-insensitive, and uses
the languages specified by ISO 639. The default is specified in the
database configuration. "distance-weight=number" A weight applied
based on the minimum distance between matches of this query. Higher
weights add to the importance of proximity (as opposed to term
matches) when the relevance order is calculated. The default value
is 0.0 (no impact of proximity). The weight should be between 64
and -16. Weights greater than 64 will have the same effect as a
weight of 64. This parameter has no effect if the word positions
index is not enabled. This parameter has no effect on searches that
use score-simple, score-random, or score-zero (because those
scoring algorithms do not consider term frequency, proximity is
irrelevant). "min-occurs=number" Specifies the minimum number of
occurrences required. If fewer that this number of words occur, the
fragment does not match. The default is 1. "max-occurs=number"
Specifies the maximum number of occurrences required. If more than
this number of words occur, the fragment does not match. The
default is unbounded. "synonym" Specifies that all of the terms in
the $text parameter are considered synonyms for scoring purposes.
The result is that occurrences of more than one of the synonyms are
scored as if there are more occurrences of the same term (as
opposed to having a separate term that contributes to score).
"lexicon-expand=value" The value is one of full, prefix-postfix,
off, or heuristic (the default is heuristic). An option with a
value of lexicon-expand=full specifies that wildcards are resolved
by expanding the pattern to words in a lexicon (if there is one
available), and turning into a series of cts:word-queries, even if
this takes a long time to evaluate. An option with a value of
lexicon-expand=prefix-postfix specifies that wildcards are resolved
by expanding the pattern to the pre- and postfixes of the words in
the word lexicon (if there is one), and turning the query into a
series of character queries, even if it takes a long time to
evaluate. An option with a value of lexicon-expand=off specifies
that wildcards are only resolved by looking up character patterns
in the search pattern index, not in the lexicon. An option with a
value of lexicon-expand=heuristic, which is the default, specifies
that wildcards are resolved by using a series of internal rules,
such as estimating the number of lexicon entries that need to be
scanned, seeing if the estimate crosses certain thresholds, and (if
appropriate), using another way besides lexicon expansion to
resolve the query. "lexicon-expansion-limit=number" Specifies the
limit for lexicon expansion. This puts a restriction on the number
of lexicon expansions that can be performed. If the limit is
exceeded, the server may raise an error depending on whether the
"limit-check" option is set. The default value for this option will
be 4096. "limit-check" Specifies that an error will be raised if
the lexicon expansion exceeds the specified limit. "no-limit-check"
Specifies that error will not be raised if the lexicon expansion
exceeds the specified limit. The server will try to resolve the
wildcard. (of xs:string)CtsQueryExpr fieldWordQuery(ServerExpression fieldName, ServerExpression text, ServerExpression options)
Provides a client interface to the cts:field-word-query server function.
fieldName - One or more field names to search
over. If multiple field names are supplied, the match can be in any
of the specified fields (or-query semantics). (of xs:string)text - The word or phrase to match. If multiple
strings are specified, the query matches if any of the words or
phrases match (or-query semantics). (of xs:string)options - Options to this query. The default is
(). Options include: "case-sensitive" A case-sensitive query.
"case-insensitive" A case-insensitive query. "diacritic-sensitive"
A diacritic-sensitive query. "diacritic-insensitive" A
diacritic-insensitive query. "punctuation-sensitive" A
punctuation-sensitive query. "punctuation-insensitive" A
punctuation-insensitive query. "whitespace-sensitive" A
whitespace-sensitive query. "whitespace-insensitive" A
whitespace-insensitive query. "stemmed" A stemmed query.
"unstemmed" An unstemmed query. "wildcarded" A wildcarded query.
"unwildcarded" An unwildcarded query. "exact" An exact match query.
Shorthand for "case-sensitive", "diacritic-sensitive",
"punctuation-sensitive", "whitespace-sensitive", "unstemmed", and
"unwildcarded". "lang=iso639code" Specifies the language of the
query. The iso639code code portion is case-insensitive, and uses
the languages specified by ISO 639. The default is specified in the
database configuration. "distance-weight=number" A weight applied
based on the minimum distance between matches of this query. Higher
weights add to the importance of proximity (as opposed to term
matches) when the relevance order is calculated. The default value
is 0.0 (no impact of proximity). The weight should be between 64
and -16. Weights greater than 64 will have the same effect as a
weight of 64. This parameter has no effect if the word positions
index is not enabled. This parameter has no effect on searches that
use score-simple, score-random, or score-zero (because those
scoring algorithms do not consider term frequency, proximity is
irrelevant). "min-occurs=number" Specifies the minimum number of
occurrences required. If fewer that this number of words occur, the
fragment does not match. The default is 1. "max-occurs=number"
Specifies the maximum number of occurrences required. If more than
this number of words occur, the fragment does not match. The
default is unbounded. "synonym" Specifies that all of the terms in
the $text parameter are considered synonyms for scoring purposes.
The result is that occurrences of more than one of the synonyms are
scored as if there are more occurrences of the same term (as
opposed to having a separate term that contributes to score).
"lexicon-expand=value" The value is one of full, prefix-postfix,
off, or heuristic (the default is heuristic). An option with a
value of lexicon-expand=full specifies that wildcards are resolved
by expanding the pattern to words in a lexicon (if there is one
available), and turning into a series of cts:word-queries, even if
this takes a long time to evaluate. An option with a value of
lexicon-expand=prefix-postfix specifies that wildcards are resolved
by expanding the pattern to the pre- and postfixes of the words in
the word lexicon (if there is one), and turning the query into a
series of character queries, even if it takes a long time to
evaluate. An option with a value of lexicon-expand=off specifies
that wildcards are only resolved by looking up character patterns
in the search pattern index, not in the lexicon. An option with a
value of lexicon-expand=heuristic, which is the default, specifies
that wildcards are resolved by using a series of internal rules,
such as estimating the number of lexicon entries that need to be
scanned, seeing if the estimate crosses certain thresholds, and (if
appropriate), using another way besides lexicon expansion to
resolve the query. "lexicon-expansion-limit=number" Specifies the
limit for lexicon expansion. This puts a restriction on the number
of lexicon expansions that can be performed. If the limit is
exceeded, the server may raise an error depending on whether the
"limit-check" option is set. The default value for this option will
be 4096. "limit-check" Specifies that an error will be raised if
the lexicon expansion exceeds the specified limit. "no-limit-check"
Specifies that error will not be raised if the lexicon expansion
exceeds the specified limit. The server will try to resolve the
wildcard. (of xs:string)CtsQueryExpr fieldWordQuery(java.lang.String fieldName, java.lang.String text, java.lang.String options, double weight)
Provides a client interface to the cts:field-word-query server function.
fieldName - One or more field names to search
over. If multiple field names are supplied, the match can be in any
of the specified fields (or-query semantics). (of xs:string)text - The word or phrase to match. If multiple
strings are specified, the query matches if any of the words or
phrases match (or-query semantics). (of xs:string)options - Options to this query. The default is
(). Options include: "case-sensitive" A case-sensitive query.
"case-insensitive" A case-insensitive query. "diacritic-sensitive"
A diacritic-sensitive query. "diacritic-insensitive" A
diacritic-insensitive query. "punctuation-sensitive" A
punctuation-sensitive query. "punctuation-insensitive" A
punctuation-insensitive query. "whitespace-sensitive" A
whitespace-sensitive query. "whitespace-insensitive" A
whitespace-insensitive query. "stemmed" A stemmed query.
"unstemmed" An unstemmed query. "wildcarded" A wildcarded query.
"unwildcarded" An unwildcarded query. "exact" An exact match query.
Shorthand for "case-sensitive", "diacritic-sensitive",
"punctuation-sensitive", "whitespace-sensitive", "unstemmed", and
"unwildcarded". "lang=iso639code" Specifies the language of the
query. The iso639code code portion is case-insensitive, and uses
the languages specified by ISO 639. The default is specified in the
database configuration. "distance-weight=number" A weight applied
based on the minimum distance between matches of this query. Higher
weights add to the importance of proximity (as opposed to term
matches) when the relevance order is calculated. The default value
is 0.0 (no impact of proximity). The weight should be between 64
and -16. Weights greater than 64 will have the same effect as a
weight of 64. This parameter has no effect if the word positions
index is not enabled. This parameter has no effect on searches that
use score-simple, score-random, or score-zero (because those
scoring algorithms do not consider term frequency, proximity is
irrelevant). "min-occurs=number" Specifies the minimum number of
occurrences required. If fewer that this number of words occur, the
fragment does not match. The default is 1. "max-occurs=number"
Specifies the maximum number of occurrences required. If more than
this number of words occur, the fragment does not match. The
default is unbounded. "synonym" Specifies that all of the terms in
the $text parameter are considered synonyms for scoring purposes.
The result is that occurrences of more than one of the synonyms are
scored as if there are more occurrences of the same term (as
opposed to having a separate term that contributes to score).
"lexicon-expand=value" The value is one of full, prefix-postfix,
off, or heuristic (the default is heuristic). An option with a
value of lexicon-expand=full specifies that wildcards are resolved
by expanding the pattern to words in a lexicon (if there is one
available), and turning into a series of cts:word-queries, even if
this takes a long time to evaluate. An option with a value of
lexicon-expand=prefix-postfix specifies that wildcards are resolved
by expanding the pattern to the pre- and postfixes of the words in
the word lexicon (if there is one), and turning the query into a
series of character queries, even if it takes a long time to
evaluate. An option with a value of lexicon-expand=off specifies
that wildcards are only resolved by looking up character patterns
in the search pattern index, not in the lexicon. An option with a
value of lexicon-expand=heuristic, which is the default, specifies
that wildcards are resolved by using a series of internal rules,
such as estimating the number of lexicon entries that need to be
scanned, seeing if the estimate crosses certain thresholds, and (if
appropriate), using another way besides lexicon expansion to
resolve the query. "lexicon-expansion-limit=number" Specifies the
limit for lexicon expansion. This puts a restriction on the number
of lexicon expansions that can be performed. If the limit is
exceeded, the server may raise an error depending on whether the
"limit-check" option is set. The default value for this option will
be 4096. "limit-check" Specifies that an error will be raised if
the lexicon expansion exceeds the specified limit. "no-limit-check"
Specifies that error will not be raised if the lexicon expansion
exceeds the specified limit. The server will try to resolve the
wildcard. (of xs:string)weight - A weight for this query. Higher weights
move search results up in the relevance order. The default is 1.0.
The weight should be between 64 and -16. Weights greater than 64
will have the same effect as a weight of 64. Weights less than the
absolute value of 0.0625 (between -0.0625 and 0.0625) are rounded
to 0, which means that they do not contribute to the score. (of
xs:double)CtsQueryExpr fieldWordQuery(ServerExpression fieldName, ServerExpression text, ServerExpression options, ServerExpression weight)
Provides a client interface to the cts:field-word-query server function.
fieldName - One or more field names to search
over. If multiple field names are supplied, the match can be in any
of the specified fields (or-query semantics). (of xs:string)text - The word or phrase to match. If multiple
strings are specified, the query matches if any of the words or
phrases match (or-query semantics). (of xs:string)options - Options to this query. The default is
(). Options include: "case-sensitive" A case-sensitive query.
"case-insensitive" A case-insensitive query. "diacritic-sensitive"
A diacritic-sensitive query. "diacritic-insensitive" A
diacritic-insensitive query. "punctuation-sensitive" A
punctuation-sensitive query. "punctuation-insensitive" A
punctuation-insensitive query. "whitespace-sensitive" A
whitespace-sensitive query. "whitespace-insensitive" A
whitespace-insensitive query. "stemmed" A stemmed query.
"unstemmed" An unstemmed query. "wildcarded" A wildcarded query.
"unwildcarded" An unwildcarded query. "exact" An exact match query.
Shorthand for "case-sensitive", "diacritic-sensitive",
"punctuation-sensitive", "whitespace-sensitive", "unstemmed", and
"unwildcarded". "lang=iso639code" Specifies the language of the
query. The iso639code code portion is case-insensitive, and uses
the languages specified by ISO 639. The default is specified in the
database configuration. "distance-weight=number" A weight applied
based on the minimum distance between matches of this query. Higher
weights add to the importance of proximity (as opposed to term
matches) when the relevance order is calculated. The default value
is 0.0 (no impact of proximity). The weight should be between 64
and -16. Weights greater than 64 will have the same effect as a
weight of 64. This parameter has no effect if the word positions
index is not enabled. This parameter has no effect on searches that
use score-simple, score-random, or score-zero (because those
scoring algorithms do not consider term frequency, proximity is
irrelevant). "min-occurs=number" Specifies the minimum number of
occurrences required. If fewer that this number of words occur, the
fragment does not match. The default is 1. "max-occurs=number"
Specifies the maximum number of occurrences required. If more than
this number of words occur, the fragment does not match. The
default is unbounded. "synonym" Specifies that all of the terms in
the $text parameter are considered synonyms for scoring purposes.
The result is that occurrences of more than one of the synonyms are
scored as if there are more occurrences of the same term (as
opposed to having a separate term that contributes to score).
"lexicon-expand=value" The value is one of full, prefix-postfix,
off, or heuristic (the default is heuristic). An option with a
value of lexicon-expand=full specifies that wildcards are resolved
by expanding the pattern to words in a lexicon (if there is one
available), and turning into a series of cts:word-queries, even if
this takes a long time to evaluate. An option with a value of
lexicon-expand=prefix-postfix specifies that wildcards are resolved
by expanding the pattern to the pre- and postfixes of the words in
the word lexicon (if there is one), and turning the query into a
series of character queries, even if it takes a long time to
evaluate. An option with a value of lexicon-expand=off specifies
that wildcards are only resolved by looking up character patterns
in the search pattern index, not in the lexicon. An option with a
value of lexicon-expand=heuristic, which is the default, specifies
that wildcards are resolved by using a series of internal rules,
such as estimating the number of lexicon entries that need to be
scanned, seeing if the estimate crosses certain thresholds, and (if
appropriate), using another way besides lexicon expansion to
resolve the query. "lexicon-expansion-limit=number" Specifies the
limit for lexicon expansion. This puts a restriction on the number
of lexicon expansions that can be performed. If the limit is
exceeded, the server may raise an error depending on whether the
"limit-check" option is set. The default value for this option will
be 4096. "limit-check" Specifies that an error will be raised if
the lexicon expansion exceeds the specified limit. "no-limit-check"
Specifies that error will not be raised if the lexicon expansion
exceeds the specified limit. The server will try to resolve the
wildcard. (of xs:string)weight - A weight for this query. Higher weights
move search results up in the relevance order. The default is 1.0.
The weight should be between 64 and -16. Weights greater than 64
will have the same effect as a weight of 64. Weights less than the
absolute value of 0.0625 (between -0.0625 and 0.0625) are rounded
to 0, which means that they do not contribute to the score. (of
xs:double)CtsReferenceExpr geospatialPathReference(java.lang.String pathExpression)
Provides a client interface to the cts:geospatial-path-reference server function.
pathExpression - A path expression. (of xs:string)CtsReferenceExpr geospatialPathReference(ServerExpression pathExpression)
Provides a client interface to the cts:geospatial-path-reference server function.
pathExpression - A path expression. (of xs:string)CtsReferenceExpr geospatialPathReference(java.lang.String pathExpression, java.lang.String options)
Provides a client interface to the cts:geospatial-path-reference server function.
pathExpression - A path expression. (of xs:string)options - Options. The default is (). Options
include: "type=type" Use the lexicon with the type specified by
type (point or long-lat-point) "coordinate-system=string" Use the
given coordinate system. Valid values are: wgs84The WGS84
coordinate system with degrees as the angular unit.
wgs84/radiansThe WGS84 coordinate system with radians as the
angular unit. wgs84/doubleThe WGS84 coordinate system at double
precision with degrees as the angular unit. wgs84/radians/doubleThe
WGS84 coordinate system at double precision with radians as the
angular unit. etrs89The ETRS89 coordinate system. etrs89/doubleThe
ETRS89 coordinate system at double precision. rawThe raw (unmapped)
coordinate system. raw/doubleThe raw coordinate system at double
precision. "precision=value" Use the coordinate system at the given
precision. Allowed values: float and double. "nullable" Allow null
values in tuples reported from cts:value-tuples when using this
lexicon. "unchecked" Read the scalar type and coordinate-system
info only from the input. Do not check the definition against the
context database. (of xs:string)CtsReferenceExpr geospatialPathReference(ServerExpression pathExpression, ServerExpression options)
Provides a client interface to the cts:geospatial-path-reference server function.
pathExpression - A path expression. (of xs:string)options - Options. The default is (). Options
include: "type=type" Use the lexicon with the type specified by
type (point or long-lat-point) "coordinate-system=string" Use the
given coordinate system. Valid values are: wgs84The WGS84
coordinate system with degrees as the angular unit.
wgs84/radiansThe WGS84 coordinate system with radians as the
angular unit. wgs84/doubleThe WGS84 coordinate system at double
precision with degrees as the angular unit. wgs84/radians/doubleThe
WGS84 coordinate system at double precision with radians as the
angular unit. etrs89The ETRS89 coordinate system. etrs89/doubleThe
ETRS89 coordinate system at double precision. rawThe raw (unmapped)
coordinate system. raw/doubleThe raw coordinate system at double
precision. "precision=value" Use the coordinate system at the given
precision. Allowed values: float and double. "nullable" Allow null
values in tuples reported from cts:value-tuples when using this
lexicon. "unchecked" Read the scalar type and coordinate-system
info only from the input. Do not check the definition against the
context database. (of xs:string)CtsReferenceExpr geospatialPathReference(java.lang.String pathExpression, java.lang.String options, ServerExpression map)
Provides a client interface to the cts:geospatial-path-reference server function.
pathExpression - A path expression. (of xs:string)options - Options. The default is (). Options
include: "type=type" Use the lexicon with the type specified by
type (point or long-lat-point) "coordinate-system=string" Use the
given coordinate system. Valid values are: wgs84The WGS84
coordinate system with degrees as the angular unit.
wgs84/radiansThe WGS84 coordinate system with radians as the
angular unit. wgs84/doubleThe WGS84 coordinate system at double
precision with degrees as the angular unit. wgs84/radians/doubleThe
WGS84 coordinate system at double precision with radians as the
angular unit. etrs89The ETRS89 coordinate system. etrs89/doubleThe
ETRS89 coordinate system at double precision. rawThe raw (unmapped)
coordinate system. raw/doubleThe raw coordinate system at double
precision. "precision=value" Use the coordinate system at the given
precision. Allowed values: float and double. "nullable" Allow null
values in tuples reported from cts:value-tuples when using this
lexicon. "unchecked" Read the scalar type and coordinate-system
info only from the input. Do not check the definition against the
context database. (of xs:string)map - A map of namespace bindings. The keys should
be namespace prefixes and the values should be namespace URIs.
These namespace bindings will be added to the in-scope namespace
bindings in the interpretation of the path. (of map:map)CtsReferenceExpr geospatialPathReference(ServerExpression pathExpression, ServerExpression options, ServerExpression map)
Provides a client interface to the cts:geospatial-path-reference server function.
pathExpression - A path expression. (of xs:string)options - Options. The default is (). Options
include: "type=type" Use the lexicon with the type specified by
type (point or long-lat-point) "coordinate-system=string" Use the
given coordinate system. Valid values are: wgs84The WGS84
coordinate system with degrees as the angular unit.
wgs84/radiansThe WGS84 coordinate system with radians as the
angular unit. wgs84/doubleThe WGS84 coordinate system at double
precision with degrees as the angular unit. wgs84/radians/doubleThe
WGS84 coordinate system at double precision with radians as the
angular unit. etrs89The ETRS89 coordinate system. etrs89/doubleThe
ETRS89 coordinate system at double precision. rawThe raw (unmapped)
coordinate system. raw/doubleThe raw coordinate system at double
precision. "precision=value" Use the coordinate system at the given
precision. Allowed values: float and double. "nullable" Allow null
values in tuples reported from cts:value-tuples when using this
lexicon. "unchecked" Read the scalar type and coordinate-system
info only from the input. Do not check the definition against the
context database. (of xs:string)map - A map of namespace bindings. The keys should
be namespace prefixes and the values should be namespace URIs.
These namespace bindings will be added to the in-scope namespace
bindings in the interpretation of the path. (of map:map)CtsReferenceExpr geospatialRegionPathReference(java.lang.String pathExpression)
Provides a client interface to the cts:geospatial-region-path-reference server function.
pathExpression - The XPath expression specified in
the index configuration. (of xs:string)CtsReferenceExpr geospatialRegionPathReference(ServerExpression pathExpression)
Provides a client interface to the cts:geospatial-region-path-reference server function.
pathExpression - The XPath expression specified in
the index configuration. (of xs:string)CtsReferenceExpr geospatialRegionPathReference(java.lang.String pathExpression, java.lang.String options)
Provides a client interface to the cts:geospatial-region-path-reference server function.
pathExpression - The XPath expression specified in
the index configuration. (of xs:string)options - Index configuration options. The default
is (). These options should match the configuration used when
creating the index. Available options: "coordinate-system=string"
Use the given coordinate system. Valid values are: wgs84The WGS84
coordinate system with degrees as the angular unit.
wgs84/radiansThe WGS84 coordinate system with radians as the
angular unit. wgs84/doubleThe WGS84 coordinate system at double
precision with degrees as the angular unit. wgs84/radians/doubleThe
WGS84 coordinate system at double precision with radians as the
angular unit. etrs89The ETRS89 coordinate system. etrs89/doubleThe
ETRS89 coordinate system at double precision. rawThe raw (unmapped)
coordinate system. raw/doubleThe raw coordinate system at double
precision. "precision=value" Use the coordinate system at the given
precision. Allowed values: float (default) and double. "unchecked"
Read the coordinate-system info only from the input. Do not check
the definition against the context database. (of xs:string)CtsReferenceExpr geospatialRegionPathReference(ServerExpression pathExpression, ServerExpression options)
Provides a client interface to the cts:geospatial-region-path-reference server function.
pathExpression - The XPath expression specified in
the index configuration. (of xs:string)options - Index configuration options. The default
is (). These options should match the configuration used when
creating the index. Available options: "coordinate-system=string"
Use the given coordinate system. Valid values are: wgs84The WGS84
coordinate system with degrees as the angular unit.
wgs84/radiansThe WGS84 coordinate system with radians as the
angular unit. wgs84/doubleThe WGS84 coordinate system at double
precision with degrees as the angular unit. wgs84/radians/doubleThe
WGS84 coordinate system at double precision with radians as the
angular unit. etrs89The ETRS89 coordinate system. etrs89/doubleThe
ETRS89 coordinate system at double precision. rawThe raw (unmapped)
coordinate system. raw/doubleThe raw coordinate system at double
precision. "precision=value" Use the coordinate system at the given
precision. Allowed values: float (default) and double. "unchecked"
Read the coordinate-system info only from the input. Do not check
the definition against the context database. (of xs:string)CtsReferenceExpr geospatialRegionPathReference(java.lang.String pathExpression, java.lang.String options, ServerExpression namespaces)
Provides a client interface to the cts:geospatial-region-path-reference server function.
pathExpression - The XPath expression specified in
the index configuration. (of xs:string)options - Index configuration options. The default
is (). These options should match the configuration used when
creating the index. Available options: "coordinate-system=string"
Use the given coordinate system. Valid values are: wgs84The WGS84
coordinate system with degrees as the angular unit.
wgs84/radiansThe WGS84 coordinate system with radians as the
angular unit. wgs84/doubleThe WGS84 coordinate system at double
precision with degrees as the angular unit. wgs84/radians/doubleThe
WGS84 coordinate system at double precision with radians as the
angular unit. etrs89The ETRS89 coordinate system. etrs89/doubleThe
ETRS89 coordinate system at double precision. rawThe raw (unmapped)
coordinate system. raw/doubleThe raw coordinate system at double
precision. "precision=value" Use the coordinate system at the given
precision. Allowed values: float (default) and double. "unchecked"
Read the coordinate-system info only from the input. Do not check
the definition against the context database. (of xs:string)namespaces - A map of namespace bindings. The keys
should be namespace prefixes and the values should be namespace
URIs. These namespace bindings will be added to the in-scope
namespace bindings in the interpretation of the path. (of map:map)CtsReferenceExpr geospatialRegionPathReference(ServerExpression pathExpression, ServerExpression options, ServerExpression namespaces)
Provides a client interface to the cts:geospatial-region-path-reference server function.
pathExpression - The XPath expression specified in
the index configuration. (of xs:string)options - Index configuration options. The default
is (). These options should match the configuration used when
creating the index. Available options: "coordinate-system=string"
Use the given coordinate system. Valid values are: wgs84The WGS84
coordinate system with degrees as the angular unit.
wgs84/radiansThe WGS84 coordinate system with radians as the
angular unit. wgs84/doubleThe WGS84 coordinate system at double
precision with degrees as the angular unit. wgs84/radians/doubleThe
WGS84 coordinate system at double precision with radians as the
angular unit. etrs89The ETRS89 coordinate system. etrs89/doubleThe
ETRS89 coordinate system at double precision. rawThe raw (unmapped)
coordinate system. raw/doubleThe raw coordinate system at double
precision. "precision=value" Use the coordinate system at the given
precision. Allowed values: float (default) and double. "unchecked"
Read the coordinate-system info only from the input. Do not check
the definition against the context database. (of xs:string)namespaces - A map of namespace bindings. The keys
should be namespace prefixes and the values should be namespace
URIs. These namespace bindings will be added to the in-scope
namespace bindings in the interpretation of the path. (of map:map)CtsReferenceExpr geospatialRegionPathReference(java.lang.String pathExpression, java.lang.String options, ServerExpression namespaces, long geohashPrecision)
Provides a client interface to the cts:geospatial-region-path-reference server function.
pathExpression - The XPath expression specified in
the index configuration. (of xs:string)options - Index configuration options. The default
is (). These options should match the configuration used when
creating the index. Available options: "coordinate-system=string"
Use the given coordinate system. Valid values are: wgs84The WGS84
coordinate system with degrees as the angular unit.
wgs84/radiansThe WGS84 coordinate system with radians as the
angular unit. wgs84/doubleThe WGS84 coordinate system at double
precision with degrees as the angular unit. wgs84/radians/doubleThe
WGS84 coordinate system at double precision with radians as the
angular unit. etrs89The ETRS89 coordinate system. etrs89/doubleThe
ETRS89 coordinate system at double precision. rawThe raw (unmapped)
coordinate system. raw/doubleThe raw coordinate system at double
precision. "precision=value" Use the coordinate system at the given
precision. Allowed values: float (default) and double. "unchecked"
Read the coordinate-system info only from the input. Do not check
the definition against the context database. (of xs:string)namespaces - A map of namespace bindings. The keys
should be namespace prefixes and the values should be namespace
URIs. These namespace bindings will be added to the in-scope
namespace bindings in the interpretation of the path. (of map:map)geohashPrecision - The geohash precision specified
in the index configuration. Values between 1 and 12 inclusive are
possible. (of xs:integer)CtsReferenceExpr geospatialRegionPathReference(ServerExpression pathExpression, ServerExpression options, ServerExpression namespaces, ServerExpression geohashPrecision)
Provides a client interface to the cts:geospatial-region-path-reference server function.
pathExpression - The XPath expression specified in
the index configuration. (of xs:string)options - Index configuration options. The default
is (). These options should match the configuration used when
creating the index. Available options: "coordinate-system=string"
Use the given coordinate system. Valid values are: wgs84The WGS84
coordinate system with degrees as the angular unit.
wgs84/radiansThe WGS84 coordinate system with radians as the
angular unit. wgs84/doubleThe WGS84 coordinate system at double
precision with degrees as the angular unit. wgs84/radians/doubleThe
WGS84 coordinate system at double precision with radians as the
angular unit. etrs89The ETRS89 coordinate system. etrs89/doubleThe
ETRS89 coordinate system at double precision. rawThe raw (unmapped)
coordinate system. raw/doubleThe raw coordinate system at double
precision. "precision=value" Use the coordinate system at the given
precision. Allowed values: float (default) and double. "unchecked"
Read the coordinate-system info only from the input. Do not check
the definition against the context database. (of xs:string)namespaces - A map of namespace bindings. The keys
should be namespace prefixes and the values should be namespace
URIs. These namespace bindings will be added to the in-scope
namespace bindings in the interpretation of the path. (of map:map)geohashPrecision - The geohash precision specified
in the index configuration. Values between 1 and 12 inclusive are
possible. (of xs:integer)CtsReferenceExpr geospatialRegionPathReference(java.lang.String pathExpression, java.lang.String options, ServerExpression namespaces, long geohashPrecision, java.lang.String units)
Provides a client interface to the cts:geospatial-region-path-reference server function.
pathExpression - The XPath expression specified in
the index configuration. (of xs:string)options - Index configuration options. The default
is (). These options should match the configuration used when
creating the index. Available options: "coordinate-system=string"
Use the given coordinate system. Valid values are: wgs84The WGS84
coordinate system with degrees as the angular unit.
wgs84/radiansThe WGS84 coordinate system with radians as the
angular unit. wgs84/doubleThe WGS84 coordinate system at double
precision with degrees as the angular unit. wgs84/radians/doubleThe
WGS84 coordinate system at double precision with radians as the
angular unit. etrs89The ETRS89 coordinate system. etrs89/doubleThe
ETRS89 coordinate system at double precision. rawThe raw (unmapped)
coordinate system. raw/doubleThe raw coordinate system at double
precision. "precision=value" Use the coordinate system at the given
precision. Allowed values: float (default) and double. "unchecked"
Read the coordinate-system info only from the input. Do not check
the definition against the context database. (of xs:string)namespaces - A map of namespace bindings. The keys
should be namespace prefixes and the values should be namespace
URIs. These namespace bindings will be added to the in-scope
namespace bindings in the interpretation of the path. (of map:map)geohashPrecision - The geohash precision specified
in the index configuration. Values between 1 and 12 inclusive are
possible. (of xs:integer)units - The units specified in the index
configuration. 'miles', 'km', 'feet', and 'meters' are valid. (of
xs:string)CtsReferenceExpr geospatialRegionPathReference(ServerExpression pathExpression, ServerExpression options, ServerExpression namespaces, ServerExpression geohashPrecision, ServerExpression units)
Provides a client interface to the cts:geospatial-region-path-reference server function.
pathExpression - The XPath expression specified in
the index configuration. (of xs:string)options - Index configuration options. The default
is (). These options should match the configuration used when
creating the index. Available options: "coordinate-system=string"
Use the given coordinate system. Valid values are: wgs84The WGS84
coordinate system with degrees as the angular unit.
wgs84/radiansThe WGS84 coordinate system with radians as the
angular unit. wgs84/doubleThe WGS84 coordinate system at double
precision with degrees as the angular unit. wgs84/radians/doubleThe
WGS84 coordinate system at double precision with radians as the
angular unit. etrs89The ETRS89 coordinate system. etrs89/doubleThe
ETRS89 coordinate system at double precision. rawThe raw (unmapped)
coordinate system. raw/doubleThe raw coordinate system at double
precision. "precision=value" Use the coordinate system at the given
precision. Allowed values: float (default) and double. "unchecked"
Read the coordinate-system info only from the input. Do not check
the definition against the context database. (of xs:string)namespaces - A map of namespace bindings. The keys
should be namespace prefixes and the values should be namespace
URIs. These namespace bindings will be added to the in-scope
namespace bindings in the interpretation of the path. (of map:map)geohashPrecision - The geohash precision specified
in the index configuration. Values between 1 and 12 inclusive are
possible. (of xs:integer)units - The units specified in the index
configuration. 'miles', 'km', 'feet', and 'meters' are valid. (of
xs:string)CtsReferenceExpr geospatialRegionPathReference(java.lang.String pathExpression, java.lang.String options, ServerExpression namespaces, long geohashPrecision, java.lang.String units, java.lang.String invalidValues)
Provides a client interface to the cts:geospatial-region-path-reference server function.
pathExpression - The XPath expression specified in
the index configuration. (of xs:string)options - Index configuration options. The default
is (). These options should match the configuration used when
creating the index. Available options: "coordinate-system=string"
Use the given coordinate system. Valid values are: wgs84The WGS84
coordinate system with degrees as the angular unit.
wgs84/radiansThe WGS84 coordinate system with radians as the
angular unit. wgs84/doubleThe WGS84 coordinate system at double
precision with degrees as the angular unit. wgs84/radians/doubleThe
WGS84 coordinate system at double precision with radians as the
angular unit. etrs89The ETRS89 coordinate system. etrs89/doubleThe
ETRS89 coordinate system at double precision. rawThe raw (unmapped)
coordinate system. raw/doubleThe raw coordinate system at double
precision. "precision=value" Use the coordinate system at the given
precision. Allowed values: float (default) and double. "unchecked"
Read the coordinate-system info only from the input. Do not check
the definition against the context database. (of xs:string)namespaces - A map of namespace bindings. The keys
should be namespace prefixes and the values should be namespace
URIs. These namespace bindings will be added to the in-scope
namespace bindings in the interpretation of the path. (of map:map)geohashPrecision - The geohash precision specified
in the index configuration. Values between 1 and 12 inclusive are
possible. (of xs:integer)units - The units specified in the index
configuration. 'miles', 'km', 'feet', and 'meters' are valid. (of
xs:string)invalidValues - The invalid values setting
specified in the index configuration. 'reject' and 'ignore' are
valid. (of xs:string)CtsReferenceExpr geospatialRegionPathReference(ServerExpression pathExpression, ServerExpression options, ServerExpression namespaces, ServerExpression geohashPrecision, ServerExpression units, ServerExpression invalidValues)
Provides a client interface to the cts:geospatial-region-path-reference server function.
pathExpression - The XPath expression specified in
the index configuration. (of xs:string)options - Index configuration options. The default
is (). These options should match the configuration used when
creating the index. Available options: "coordinate-system=string"
Use the given coordinate system. Valid values are: wgs84The WGS84
coordinate system with degrees as the angular unit.
wgs84/radiansThe WGS84 coordinate system with radians as the
angular unit. wgs84/doubleThe WGS84 coordinate system at double
precision with degrees as the angular unit. wgs84/radians/doubleThe
WGS84 coordinate system at double precision with radians as the
angular unit. etrs89The ETRS89 coordinate system. etrs89/doubleThe
ETRS89 coordinate system at double precision. rawThe raw (unmapped)
coordinate system. raw/doubleThe raw coordinate system at double
precision. "precision=value" Use the coordinate system at the given
precision. Allowed values: float (default) and double. "unchecked"
Read the coordinate-system info only from the input. Do not check
the definition against the context database. (of xs:string)namespaces - A map of namespace bindings. The keys
should be namespace prefixes and the values should be namespace
URIs. These namespace bindings will be added to the in-scope
namespace bindings in the interpretation of the path. (of map:map)geohashPrecision - The geohash precision specified
in the index configuration. Values between 1 and 12 inclusive are
possible. (of xs:integer)units - The units specified in the index
configuration. 'miles', 'km', 'feet', and 'meters' are valid. (of
xs:string)invalidValues - The invalid values setting
specified in the index configuration. 'reject' and 'ignore' are
valid. (of xs:string)CtsQueryExpr geospatialRegionQuery(ServerExpression reference, java.lang.String operation, CtsRegionExpr... region)
Provides a client interface to the cts:geospatial-region-query server function.
reference - Zero or more geospatial path region
index references that identify regions in your content. To create a
reference, see cts:geospatial-region-path-reference. (of cts:reference)operation - The match operation to apply between
the regions specified in the $geospatial-region-reference parameter
and the regions in the $regions parameter. Allowed values:
contains, covered-by, covers, disjoint, intersects, overlaps,
within, equals, touches, crosses. See the Usage Notes for details.
(of xs:string)region - Criteria regions to match against the
regions specified in the $geospatial-region-reference parameter.
These regions function as the right operand of $operation. (of
cts:region)CtsQueryExpr geospatialRegionQuery(ServerExpression reference, ServerExpression operation, ServerExpression region)
Provides a client interface to the cts:geospatial-region-query server function.
reference - Zero or more geospatial path region
index references that identify regions in your content. To create a
reference, see cts:geospatial-region-path-reference. (of cts:reference)operation - The match operation to apply between
the regions specified in the $geospatial-region-reference parameter
and the regions in the $regions parameter. Allowed values:
contains, covered-by, covers, disjoint, intersects, overlaps,
within, equals, touches, crosses. See the Usage Notes for details.
(of xs:string)region - Criteria regions to match against the
regions specified in the $geospatial-region-reference parameter.
These regions function as the right operand of $operation. (of
cts:region)CtsQueryExpr geospatialRegionQuery(ServerExpression reference, java.lang.String operation, ServerExpression region, java.lang.String... options)
Provides a client interface to the cts:geospatial-region-query server function.
reference - Zero or more geospatial path region
index references that identify regions in your content. To create a
reference, see cts:geospatial-region-path-reference. (of cts:reference)operation - The match operation to apply between
the regions specified in the $geospatial-region-reference parameter
and the regions in the $regions parameter. Allowed values:
contains, covered-by, covers, disjoint, intersects, overlaps,
within, equals, touches, crosses. See the Usage Notes for details.
(of xs:string)region - Criteria regions to match against the
regions specified in the $geospatial-region-reference parameter.
These regions function as the right operand of $operation. (of
cts:region)options - Options to this query. The default is
(). Available options: "units=value" Measure distances and the
radii of circles using the given units. Allowed values: miles
(default), km, feet, and meters. This option only affects regions
provided in the $regions parameter, not regions stored in
documents. "score-function=function" Use the selected scoring
function. The score function may be: linearUse a linear function of
the difference between the specified query value and the matching
value in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $regions parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrence of the same term (as opposed to having a
separate term that contributes to score). "tolerance=distance"
Tolerance is the largest allowable variation in geometry
calculations. If the distance between two points is less than
tolerance, then the two points are considered equal. For the raw
coordinate system, use the units of the coordinates. For geographic
coordinate systems, use the units specified by the units option.
(of xs:string)CtsQueryExpr geospatialRegionQuery(ServerExpression reference, ServerExpression operation, ServerExpression region, ServerExpression options)
Provides a client interface to the cts:geospatial-region-query server function.
reference - Zero or more geospatial path region
index references that identify regions in your content. To create a
reference, see cts:geospatial-region-path-reference. (of cts:reference)operation - The match operation to apply between
the regions specified in the $geospatial-region-reference parameter
and the regions in the $regions parameter. Allowed values:
contains, covered-by, covers, disjoint, intersects, overlaps,
within, equals, touches, crosses. See the Usage Notes for details.
(of xs:string)region - Criteria regions to match against the
regions specified in the $geospatial-region-reference parameter.
These regions function as the right operand of $operation. (of
cts:region)options - Options to this query. The default is
(). Available options: "units=value" Measure distances and the
radii of circles using the given units. Allowed values: miles
(default), km, feet, and meters. This option only affects regions
provided in the $regions parameter, not regions stored in
documents. "score-function=function" Use the selected scoring
function. The score function may be: linearUse a linear function of
the difference between the specified query value and the matching
value in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $regions parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrence of the same term (as opposed to having a
separate term that contributes to score). "tolerance=distance"
Tolerance is the largest allowable variation in geometry
calculations. If the distance between two points is less than
tolerance, then the two points are considered equal. For the raw
coordinate system, use the units of the coordinates. For geographic
coordinate systems, use the units specified by the units option.
(of xs:string)CtsQueryExpr geospatialRegionQuery(ServerExpression reference, java.lang.String operation, ServerExpression region, java.lang.String options, double weight)
Provides a client interface to the cts:geospatial-region-query server function.
reference - Zero or more geospatial path region
index references that identify regions in your content. To create a
reference, see cts:geospatial-region-path-reference. (of cts:reference)operation - The match operation to apply between
the regions specified in the $geospatial-region-reference parameter
and the regions in the $regions parameter. Allowed values:
contains, covered-by, covers, disjoint, intersects, overlaps,
within, equals, touches, crosses. See the Usage Notes for details.
(of xs:string)region - Criteria regions to match against the
regions specified in the $geospatial-region-reference parameter.
These regions function as the right operand of $operation. (of
cts:region)options - Options to this query. The default is
(). Available options: "units=value" Measure distances and the
radii of circles using the given units. Allowed values: miles
(default), km, feet, and meters. This option only affects regions
provided in the $regions parameter, not regions stored in
documents. "score-function=function" Use the selected scoring
function. The score function may be: linearUse a linear function of
the difference between the specified query value and the matching
value in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $regions parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrence of the same term (as opposed to having a
separate term that contributes to score). "tolerance=distance"
Tolerance is the largest allowable variation in geometry
calculations. If the distance between two points is less than
tolerance, then the two points are considered equal. For the raw
coordinate system, use the units of the coordinates. For geographic
coordinate systems, use the units specified by the units option.
(of xs:string)weight - A weight for this query. The default is
1.0. (of xs:double)CtsQueryExpr geospatialRegionQuery(ServerExpression reference, ServerExpression operation, ServerExpression region, ServerExpression options, ServerExpression weight)
Provides a client interface to the cts:geospatial-region-query server function.
reference - Zero or more geospatial path region
index references that identify regions in your content. To create a
reference, see cts:geospatial-region-path-reference. (of cts:reference)operation - The match operation to apply between
the regions specified in the $geospatial-region-reference parameter
and the regions in the $regions parameter. Allowed values:
contains, covered-by, covers, disjoint, intersects, overlaps,
within, equals, touches, crosses. See the Usage Notes for details.
(of xs:string)region - Criteria regions to match against the
regions specified in the $geospatial-region-reference parameter.
These regions function as the right operand of $operation. (of
cts:region)options - Options to this query. The default is
(). Available options: "units=value" Measure distances and the
radii of circles using the given units. Allowed values: miles
(default), km, feet, and meters. This option only affects regions
provided in the $regions parameter, not regions stored in
documents. "score-function=function" Use the selected scoring
function. The score function may be: linearUse a linear function of
the difference between the specified query value and the matching
value in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $regions parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrence of the same term (as opposed to having a
separate term that contributes to score). "tolerance=distance"
Tolerance is the largest allowable variation in geometry
calculations. If the distance between two points is less than
tolerance, then the two points are considered equal. For the raw
coordinate system, use the units of the coordinates. For geographic
coordinate systems, use the units specified by the units option.
(of xs:string)weight - A weight for this query. The default is
1.0. (of xs:double)CtsReferenceExpr iriReference()
Provides a client interface to the cts:iri-reference server function.
CtsQueryExpr jsonPropertyChildGeospatialQuery(java.lang.String propertyName, java.lang.String childName, CtsRegionExpr... region)
Provides a client interface to the cts:json-property-child-geospatial-query server function.
propertyName - One or more parent property names
to match. When multiple names are specified, the query matches if
any name matches. (of xs:string)childName - One or more child property names to
match. When multiple names are specified, the query matches if any
name matches; however, only the first matching latitude child in
any point instance will be checked. The property must specify both
latitude and longitude coordinates. (of xs:string)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)CtsQueryExpr jsonPropertyChildGeospatialQuery(ServerExpression propertyName, ServerExpression childName, ServerExpression region)
Provides a client interface to the cts:json-property-child-geospatial-query server function.
propertyName - One or more parent property names
to match. When multiple names are specified, the query matches if
any name matches. (of xs:string)childName - One or more child property names to
match. When multiple names are specified, the query matches if any
name matches; however, only the first matching latitude child in
any point instance will be checked. The property must specify both
latitude and longitude coordinates. (of xs:string)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)CtsQueryExpr jsonPropertyChildGeospatialQuery(java.lang.String propertyName, java.lang.String childName, ServerExpression region, java.lang.String... options)
Provides a client interface to the cts:json-property-child-geospatial-query server function.
propertyName - One or more parent property names
to match. When multiple names are specified, the query matches if
any name matches. (of xs:string)childName - One or more child property names to
match. When multiple names are specified, the query matches if any
name matches; however, only the first matching latitude child in
any point instance will be checked. The property must specify both
latitude and longitude coordinates. (of xs:string)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)options - Options to this query. The default is
(). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system with degrees as the angular unit. wgs84/radiansThe WGS84
coordinate system with radians as the angular unit. wgs84/doubleThe
WGS84 coordinate system at double precision with degrees as the
angular unit. wgs84/radians/doubleThe WGS84 coordinate system at
double precision with radians as the angular unit. etrs89The ETRS89
coordinate system. etrs89/doubleThe ETRS89 coordinate system at
double precision. rawThe raw (unmapped) coordinate system.
raw/doubleThe raw coordinate system at double precision.
"precision=string" Use the coordinate system at the given
precision. Allowed values: float (default) and double.
"units=value" Measure distance and the radii of circles in the
specified units. Allowed values: miles (default), km, feet, meters.
"boundaries-included" Points on boxes', circles', and polygons'
boundaries are counted as matching. This is the default.
"boundaries-excluded" Points on boxes', circles', and polygons'
boundaries are not counted as matching.
"boundaries-latitude-excluded" Points on boxes' latitude boundaries
are not counted as matching. "boundaries-longitude-excluded" Points
on boxes' longitude boundaries are not counted as matching.
"boundaries-south-excluded" Points on the boxes' southern
boundaries are not counted as matching. "boundaries-west-excluded"
Points on the boxes' western boundaries are not counted as
matching. "boundaries-north-excluded" Points on the boxes' northern
boundaries are not counted as matching. "boundaries-east-excluded"
Points on the boxes' eastern boundaries are not counted as
matching. "boundaries-circle-excluded" Points on circles' boundary
are not counted as matching. "boundaries-endpoints-excluded" Points
on linestrings' boundary (the endpoints) are not counted as
matching. "cached" Cache the results of this query in the list
cache. "uncached" Do not cache the results of this query in the
list cache. "type=long-lat-point" Specifies the format for the
point in the data as longitude first, latitude second. "type=point"
Specifies the format for the point in the data as latitude first,
longitude second. This is the default format.
"score-function=function" Use the selected scoring function. The
score function may be: linearUse a linear function of the
difference between the specified query value and the matching value
in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $regions parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrence of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)CtsQueryExpr jsonPropertyChildGeospatialQuery(ServerExpression propertyName, ServerExpression childName, ServerExpression region, ServerExpression options)
Provides a client interface to the cts:json-property-child-geospatial-query server function.
propertyName - One or more parent property names
to match. When multiple names are specified, the query matches if
any name matches. (of xs:string)childName - One or more child property names to
match. When multiple names are specified, the query matches if any
name matches; however, only the first matching latitude child in
any point instance will be checked. The property must specify both
latitude and longitude coordinates. (of xs:string)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)options - Options to this query. The default is
(). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system with degrees as the angular unit. wgs84/radiansThe WGS84
coordinate system with radians as the angular unit. wgs84/doubleThe
WGS84 coordinate system at double precision with degrees as the
angular unit. wgs84/radians/doubleThe WGS84 coordinate system at
double precision with radians as the angular unit. etrs89The ETRS89
coordinate system. etrs89/doubleThe ETRS89 coordinate system at
double precision. rawThe raw (unmapped) coordinate system.
raw/doubleThe raw coordinate system at double precision.
"precision=string" Use the coordinate system at the given
precision. Allowed values: float (default) and double.
"units=value" Measure distance and the radii of circles in the
specified units. Allowed values: miles (default), km, feet, meters.
"boundaries-included" Points on boxes', circles', and polygons'
boundaries are counted as matching. This is the default.
"boundaries-excluded" Points on boxes', circles', and polygons'
boundaries are not counted as matching.
"boundaries-latitude-excluded" Points on boxes' latitude boundaries
are not counted as matching. "boundaries-longitude-excluded" Points
on boxes' longitude boundaries are not counted as matching.
"boundaries-south-excluded" Points on the boxes' southern
boundaries are not counted as matching. "boundaries-west-excluded"
Points on the boxes' western boundaries are not counted as
matching. "boundaries-north-excluded" Points on the boxes' northern
boundaries are not counted as matching. "boundaries-east-excluded"
Points on the boxes' eastern boundaries are not counted as
matching. "boundaries-circle-excluded" Points on circles' boundary
are not counted as matching. "boundaries-endpoints-excluded" Points
on linestrings' boundary (the endpoints) are not counted as
matching. "cached" Cache the results of this query in the list
cache. "uncached" Do not cache the results of this query in the
list cache. "type=long-lat-point" Specifies the format for the
point in the data as longitude first, latitude second. "type=point"
Specifies the format for the point in the data as latitude first,
longitude second. This is the default format.
"score-function=function" Use the selected scoring function. The
score function may be: linearUse a linear function of the
difference between the specified query value and the matching value
in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $regions parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrence of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)CtsQueryExpr jsonPropertyChildGeospatialQuery(java.lang.String propertyName, java.lang.String childName, ServerExpression region, java.lang.String options, double weight)
Provides a client interface to the cts:json-property-child-geospatial-query server function.
propertyName - One or more parent property names
to match. When multiple names are specified, the query matches if
any name matches. (of xs:string)childName - One or more child property names to
match. When multiple names are specified, the query matches if any
name matches; however, only the first matching latitude child in
any point instance will be checked. The property must specify both
latitude and longitude coordinates. (of xs:string)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)options - Options to this query. The default is
(). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system with degrees as the angular unit. wgs84/radiansThe WGS84
coordinate system with radians as the angular unit. wgs84/doubleThe
WGS84 coordinate system at double precision with degrees as the
angular unit. wgs84/radians/doubleThe WGS84 coordinate system at
double precision with radians as the angular unit. etrs89The ETRS89
coordinate system. etrs89/doubleThe ETRS89 coordinate system at
double precision. rawThe raw (unmapped) coordinate system.
raw/doubleThe raw coordinate system at double precision.
"precision=string" Use the coordinate system at the given
precision. Allowed values: float (default) and double.
"units=value" Measure distance and the radii of circles in the
specified units. Allowed values: miles (default), km, feet, meters.
"boundaries-included" Points on boxes', circles', and polygons'
boundaries are counted as matching. This is the default.
"boundaries-excluded" Points on boxes', circles', and polygons'
boundaries are not counted as matching.
"boundaries-latitude-excluded" Points on boxes' latitude boundaries
are not counted as matching. "boundaries-longitude-excluded" Points
on boxes' longitude boundaries are not counted as matching.
"boundaries-south-excluded" Points on the boxes' southern
boundaries are not counted as matching. "boundaries-west-excluded"
Points on the boxes' western boundaries are not counted as
matching. "boundaries-north-excluded" Points on the boxes' northern
boundaries are not counted as matching. "boundaries-east-excluded"
Points on the boxes' eastern boundaries are not counted as
matching. "boundaries-circle-excluded" Points on circles' boundary
are not counted as matching. "boundaries-endpoints-excluded" Points
on linestrings' boundary (the endpoints) are not counted as
matching. "cached" Cache the results of this query in the list
cache. "uncached" Do not cache the results of this query in the
list cache. "type=long-lat-point" Specifies the format for the
point in the data as longitude first, latitude second. "type=point"
Specifies the format for the point in the data as latitude first,
longitude second. This is the default format.
"score-function=function" Use the selected scoring function. The
score function may be: linearUse a linear function of the
difference between the specified query value and the matching value
in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $regions parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrence of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)weight - A weight for this query. The default is
1.0. (of xs:double)CtsQueryExpr jsonPropertyChildGeospatialQuery(ServerExpression propertyName, ServerExpression childName, ServerExpression region, ServerExpression options, ServerExpression weight)
Provides a client interface to the cts:json-property-child-geospatial-query server function.
propertyName - One or more parent property names
to match. When multiple names are specified, the query matches if
any name matches. (of xs:string)childName - One or more child property names to
match. When multiple names are specified, the query matches if any
name matches; however, only the first matching latitude child in
any point instance will be checked. The property must specify both
latitude and longitude coordinates. (of xs:string)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)options - Options to this query. The default is
(). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system with degrees as the angular unit. wgs84/radiansThe WGS84
coordinate system with radians as the angular unit. wgs84/doubleThe
WGS84 coordinate system at double precision with degrees as the
angular unit. wgs84/radians/doubleThe WGS84 coordinate system at
double precision with radians as the angular unit. etrs89The ETRS89
coordinate system. etrs89/doubleThe ETRS89 coordinate system at
double precision. rawThe raw (unmapped) coordinate system.
raw/doubleThe raw coordinate system at double precision.
"precision=string" Use the coordinate system at the given
precision. Allowed values: float (default) and double.
"units=value" Measure distance and the radii of circles in the
specified units. Allowed values: miles (default), km, feet, meters.
"boundaries-included" Points on boxes', circles', and polygons'
boundaries are counted as matching. This is the default.
"boundaries-excluded" Points on boxes', circles', and polygons'
boundaries are not counted as matching.
"boundaries-latitude-excluded" Points on boxes' latitude boundaries
are not counted as matching. "boundaries-longitude-excluded" Points
on boxes' longitude boundaries are not counted as matching.
"boundaries-south-excluded" Points on the boxes' southern
boundaries are not counted as matching. "boundaries-west-excluded"
Points on the boxes' western boundaries are not counted as
matching. "boundaries-north-excluded" Points on the boxes' northern
boundaries are not counted as matching. "boundaries-east-excluded"
Points on the boxes' eastern boundaries are not counted as
matching. "boundaries-circle-excluded" Points on circles' boundary
are not counted as matching. "boundaries-endpoints-excluded" Points
on linestrings' boundary (the endpoints) are not counted as
matching. "cached" Cache the results of this query in the list
cache. "uncached" Do not cache the results of this query in the
list cache. "type=long-lat-point" Specifies the format for the
point in the data as longitude first, latitude second. "type=point"
Specifies the format for the point in the data as latitude first,
longitude second. This is the default format.
"score-function=function" Use the selected scoring function. The
score function may be: linearUse a linear function of the
difference between the specified query value and the matching value
in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $regions parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrence of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)weight - A weight for this query. The default is
1.0. (of xs:double)CtsQueryExpr jsonPropertyGeospatialQuery(java.lang.String propertyName, CtsRegionExpr... region)
Provides a client interface to the cts:json-property-geospatial-query server function.
propertyName - One or more json property names to
match. When multiple names are specified, the query matches if any
name matches. (of xs:string)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)CtsQueryExpr jsonPropertyGeospatialQuery(ServerExpression propertyName, ServerExpression region)
Provides a client interface to the cts:json-property-geospatial-query server function.
propertyName - One or more json property names to
match. When multiple names are specified, the query matches if any
name matches. (of xs:string)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)CtsQueryExpr jsonPropertyGeospatialQuery(java.lang.String propertyName, ServerExpression region, java.lang.String... options)
Provides a client interface to the cts:json-property-geospatial-query server function.
propertyName - One or more json property names to
match. When multiple names are specified, the query matches if any
name matches. (of xs:string)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)options - Options to this query. The default is
(). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system with degrees as the angular unit. wgs84/radiansThe WGS84
coordinate system with radians as the angular unit. wgs84/doubleThe
WGS84 coordinate system at double precision with degrees as the
angular unit. wgs84/radians/doubleThe WGS84 coordinate system at
double precision with radians as the angular unit. etrs89The ETRS89
coordinate system. etrs89/doubleThe ETRS89 coordinate system at
double precision. rawThe raw (unmapped) coordinate system.
raw/doubleThe raw coordinate system at double precision.
"precision=string" Use the coordinate system at the given
precision. Allowed values: float (default) and double.
"units=value" Measure distance and the radii of circles in the
specified units. Allowed values: miles (default), km, feet, meters.
"boundaries-included" Points on boxes', circles', and polygons'
boundaries are counted as matching. This is the default.
"boundaries-excluded" Points on boxes', circles', and polygons'
boundaries are not counted as matching.
"boundaries-latitude-excluded" Points on boxes' latitude boundaries
are not counted as matching. "boundaries-longitude-excluded" Points
on boxes' longitude boundaries are not counted as matching.
"boundaries-south-excluded" Points on the boxes' southern
boundaries are not counted as matching. "boundaries-west-excluded"
Points on the boxes' western boundaries are not counted as
matching. "boundaries-north-excluded" Points on the boxes' northern
boundaries are not counted as matching. "boundaries-east-excluded"
Points on the boxes' eastern boundaries are not counted as
matching. "boundaries-circle-excluded" Points on circles' boundary
are not counted as matching. "boundaries-endpoints-excluded" Points
on linestrings' boundary (the endpoints) are not counted as
matching. "cached" Cache the results of this query in the list
cache. "uncached" Do not cache the results of this query in the
list cache. "type=long-lat-point" Specifies the format for the
point in the data as longitude first, latitude second. "type=point"
Specifies the format for the point in the data as latitude first,
longitude second. This is the default format.
"score-function=function" Use the selected scoring function. The
score function may be: linearUse a linear function of the
difference between the specified query value and the matching value
in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $regions parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrence of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)CtsQueryExpr jsonPropertyGeospatialQuery(ServerExpression propertyName, ServerExpression region, ServerExpression options)
Provides a client interface to the cts:json-property-geospatial-query server function.
propertyName - One or more json property names to
match. When multiple names are specified, the query matches if any
name matches. (of xs:string)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)options - Options to this query. The default is
(). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system with degrees as the angular unit. wgs84/radiansThe WGS84
coordinate system with radians as the angular unit. wgs84/doubleThe
WGS84 coordinate system at double precision with degrees as the
angular unit. wgs84/radians/doubleThe WGS84 coordinate system at
double precision with radians as the angular unit. etrs89The ETRS89
coordinate system. etrs89/doubleThe ETRS89 coordinate system at
double precision. rawThe raw (unmapped) coordinate system.
raw/doubleThe raw coordinate system at double precision.
"precision=string" Use the coordinate system at the given
precision. Allowed values: float (default) and double.
"units=value" Measure distance and the radii of circles in the
specified units. Allowed values: miles (default), km, feet, meters.
"boundaries-included" Points on boxes', circles', and polygons'
boundaries are counted as matching. This is the default.
"boundaries-excluded" Points on boxes', circles', and polygons'
boundaries are not counted as matching.
"boundaries-latitude-excluded" Points on boxes' latitude boundaries
are not counted as matching. "boundaries-longitude-excluded" Points
on boxes' longitude boundaries are not counted as matching.
"boundaries-south-excluded" Points on the boxes' southern
boundaries are not counted as matching. "boundaries-west-excluded"
Points on the boxes' western boundaries are not counted as
matching. "boundaries-north-excluded" Points on the boxes' northern
boundaries are not counted as matching. "boundaries-east-excluded"
Points on the boxes' eastern boundaries are not counted as
matching. "boundaries-circle-excluded" Points on circles' boundary
are not counted as matching. "boundaries-endpoints-excluded" Points
on linestrings' boundary (the endpoints) are not counted as
matching. "cached" Cache the results of this query in the list
cache. "uncached" Do not cache the results of this query in the
list cache. "type=long-lat-point" Specifies the format for the
point in the data as longitude first, latitude second. "type=point"
Specifies the format for the point in the data as latitude first,
longitude second. This is the default format.
"score-function=function" Use the selected scoring function. The
score function may be: linearUse a linear function of the
difference between the specified query value and the matching value
in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $regions parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrence of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)CtsQueryExpr jsonPropertyGeospatialQuery(java.lang.String propertyName, ServerExpression region, java.lang.String options, double weight)
Provides a client interface to the cts:json-property-geospatial-query server function.
propertyName - One or more json property names to
match. When multiple names are specified, the query matches if any
name matches. (of xs:string)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)options - Options to this query. The default is
(). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system with degrees as the angular unit. wgs84/radiansThe WGS84
coordinate system with radians as the angular unit. wgs84/doubleThe
WGS84 coordinate system at double precision with degrees as the
angular unit. wgs84/radians/doubleThe WGS84 coordinate system at
double precision with radians as the angular unit. etrs89The ETRS89
coordinate system. etrs89/doubleThe ETRS89 coordinate system at
double precision. rawThe raw (unmapped) coordinate system.
raw/doubleThe raw coordinate system at double precision.
"precision=string" Use the coordinate system at the given
precision. Allowed values: float (default) and double.
"units=value" Measure distance and the radii of circles in the
specified units. Allowed values: miles (default), km, feet, meters.
"boundaries-included" Points on boxes', circles', and polygons'
boundaries are counted as matching. This is the default.
"boundaries-excluded" Points on boxes', circles', and polygons'
boundaries are not counted as matching.
"boundaries-latitude-excluded" Points on boxes' latitude boundaries
are not counted as matching. "boundaries-longitude-excluded" Points
on boxes' longitude boundaries are not counted as matching.
"boundaries-south-excluded" Points on the boxes' southern
boundaries are not counted as matching. "boundaries-west-excluded"
Points on the boxes' western boundaries are not counted as
matching. "boundaries-north-excluded" Points on the boxes' northern
boundaries are not counted as matching. "boundaries-east-excluded"
Points on the boxes' eastern boundaries are not counted as
matching. "boundaries-circle-excluded" Points on circles' boundary
are not counted as matching. "boundaries-endpoints-excluded" Points
on linestrings' boundary (the endpoints) are not counted as
matching. "cached" Cache the results of this query in the list
cache. "uncached" Do not cache the results of this query in the
list cache. "type=long-lat-point" Specifies the format for the
point in the data as longitude first, latitude second. "type=point"
Specifies the format for the point in the data as latitude first,
longitude second. This is the default format.
"score-function=function" Use the selected scoring function. The
score function may be: linearUse a linear function of the
difference between the specified query value and the matching value
in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $regions parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrence of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)weight - A weight for this query. The default is
1.0. (of xs:double)CtsQueryExpr jsonPropertyGeospatialQuery(ServerExpression propertyName, ServerExpression region, ServerExpression options, ServerExpression weight)
Provides a client interface to the cts:json-property-geospatial-query server function.
propertyName - One or more json property names to
match. When multiple names are specified, the query matches if any
name matches. (of xs:string)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)options - Options to this query. The default is
(). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system with degrees as the angular unit. wgs84/radiansThe WGS84
coordinate system with radians as the angular unit. wgs84/doubleThe
WGS84 coordinate system at double precision with degrees as the
angular unit. wgs84/radians/doubleThe WGS84 coordinate system at
double precision with radians as the angular unit. etrs89The ETRS89
coordinate system. etrs89/doubleThe ETRS89 coordinate system at
double precision. rawThe raw (unmapped) coordinate system.
raw/doubleThe raw coordinate system at double precision.
"precision=string" Use the coordinate system at the given
precision. Allowed values: float (default) and double.
"units=value" Measure distance and the radii of circles in the
specified units. Allowed values: miles (default), km, feet, meters.
"boundaries-included" Points on boxes', circles', and polygons'
boundaries are counted as matching. This is the default.
"boundaries-excluded" Points on boxes', circles', and polygons'
boundaries are not counted as matching.
"boundaries-latitude-excluded" Points on boxes' latitude boundaries
are not counted as matching. "boundaries-longitude-excluded" Points
on boxes' longitude boundaries are not counted as matching.
"boundaries-south-excluded" Points on the boxes' southern
boundaries are not counted as matching. "boundaries-west-excluded"
Points on the boxes' western boundaries are not counted as
matching. "boundaries-north-excluded" Points on the boxes' northern
boundaries are not counted as matching. "boundaries-east-excluded"
Points on the boxes' eastern boundaries are not counted as
matching. "boundaries-circle-excluded" Points on circles' boundary
are not counted as matching. "boundaries-endpoints-excluded" Points
on linestrings' boundary (the endpoints) are not counted as
matching. "cached" Cache the results of this query in the list
cache. "uncached" Do not cache the results of this query in the
list cache. "type=long-lat-point" Specifies the format for the
point in the data as longitude first, latitude second. "type=point"
Specifies the format for the point in the data as latitude first,
longitude second. This is the default format.
"score-function=function" Use the selected scoring function. The
score function may be: linearUse a linear function of the
difference between the specified query value and the matching value
in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $regions parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrence of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)weight - A weight for this query. The default is
1.0. (of xs:double)CtsQueryExpr jsonPropertyPairGeospatialQuery(java.lang.String propertyName, java.lang.String latitudeName, java.lang.String longitudeName, CtsRegionExpr... region)
Provides a client interface to the cts:json-property-pair-geospatial-query server function.
propertyName - One or more parent property names
to match. When multiple names are specified, the query matches if
any name matches. (of xs:string)latitudeName - One or more latitude property names
to match. When multiple names are specified, the query matches if
any name matches; however, only the first matching latitude child
in any point instance will be checked. (of xs:string)longitudeName - One or more longitude property
names to match. When multiple names are specified, the query
matches if any name matches; however, only the first matching
longitude child in any point instance will be checked. (of xs:string)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)CtsQueryExpr jsonPropertyPairGeospatialQuery(ServerExpression propertyName, ServerExpression latitudeName, ServerExpression longitudeName, ServerExpression region)
Provides a client interface to the cts:json-property-pair-geospatial-query server function.
propertyName - One or more parent property names
to match. When multiple names are specified, the query matches if
any name matches. (of xs:string)latitudeName - One or more latitude property names
to match. When multiple names are specified, the query matches if
any name matches; however, only the first matching latitude child
in any point instance will be checked. (of xs:string)longitudeName - One or more longitude property
names to match. When multiple names are specified, the query
matches if any name matches; however, only the first matching
longitude child in any point instance will be checked. (of xs:string)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)CtsQueryExpr jsonPropertyPairGeospatialQuery(java.lang.String propertyName, java.lang.String latitudeName, java.lang.String longitudeName, ServerExpression region, java.lang.String... options)
Provides a client interface to the cts:json-property-pair-geospatial-query server function.
propertyName - One or more parent property names
to match. When multiple names are specified, the query matches if
any name matches. (of xs:string)latitudeName - One or more latitude property names
to match. When multiple names are specified, the query matches if
any name matches; however, only the first matching latitude child
in any point instance will be checked. (of xs:string)longitudeName - One or more longitude property
names to match. When multiple names are specified, the query
matches if any name matches; however, only the first matching
longitude child in any point instance will be checked. (of xs:string)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)options - Options to this query. The default is
(). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system with degrees as the angular unit. wgs84/radiansThe WGS84
coordinate system with radians as the angular unit. wgs84/doubleThe
WGS84 coordinate system at double precision with degrees as the
angular unit. wgs84/radians/doubleThe WGS84 coordinate system at
double precision with radians as the angular unit. etrs89The ETRS89
coordinate system. etrs89/doubleThe ETRS89 coordinate system at
double precision. rawThe raw (unmapped) coordinate system.
raw/doubleThe raw coordinate system at double precision.
"precision=value" Use the coordinate system at the given precision.
Allowed values: float and double. "units=value" Measure distance
and the radii of circles in the specified units. Allowed values:
miles (default), km, feet, meters. "boundaries-included" Points on
boxes', circles', and polygons' boundaries are counted as matching.
This is the default. "boundaries-excluded" Points on boxes',
circles', and polygons' boundaries are not counted as matching.
"boundaries-latitude-excluded" Points on boxes' latitude boundaries
are not counted as matching. "boundaries-longitude-excluded" Points
on boxes' longitude boundaries are not counted as matching.
"boundaries-south-excluded" Points on the boxes' southern
boundaries are not counted as matching. "boundaries-west-excluded"
Points on the boxes' western boundaries are not counted as
matching. "boundaries-north-excluded" Points on the boxes' northern
boundaries are not counted as matching. "boundaries-east-excluded"
Points on the boxes' eastern boundaries are not counted as
matching. "boundaries-circle-excluded" Points on circles' boundary
are not counted as matching. "boundaries-endpoints-excluded" Points
on linestrings' boundary (the endpoints) are not counted as
matching. "cached" Cache the results of this query in the list
cache. "uncached" Do not cache the results of this query in the
list cache. "score-function=function" Use the selected scoring
function. The score function may be: linearUse a linear function of
the difference between the specified query value and the matching
value in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $regions parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrence of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)CtsQueryExpr jsonPropertyPairGeospatialQuery(ServerExpression propertyName, ServerExpression latitudeName, ServerExpression longitudeName, ServerExpression region, ServerExpression options)
Provides a client interface to the cts:json-property-pair-geospatial-query server function.
propertyName - One or more parent property names
to match. When multiple names are specified, the query matches if
any name matches. (of xs:string)latitudeName - One or more latitude property names
to match. When multiple names are specified, the query matches if
any name matches; however, only the first matching latitude child
in any point instance will be checked. (of xs:string)longitudeName - One or more longitude property
names to match. When multiple names are specified, the query
matches if any name matches; however, only the first matching
longitude child in any point instance will be checked. (of xs:string)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)options - Options to this query. The default is
(). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system with degrees as the angular unit. wgs84/radiansThe WGS84
coordinate system with radians as the angular unit. wgs84/doubleThe
WGS84 coordinate system at double precision with degrees as the
angular unit. wgs84/radians/doubleThe WGS84 coordinate system at
double precision with radians as the angular unit. etrs89The ETRS89
coordinate system. etrs89/doubleThe ETRS89 coordinate system at
double precision. rawThe raw (unmapped) coordinate system.
raw/doubleThe raw coordinate system at double precision.
"precision=value" Use the coordinate system at the given precision.
Allowed values: float and double. "units=value" Measure distance
and the radii of circles in the specified units. Allowed values:
miles (default), km, feet, meters. "boundaries-included" Points on
boxes', circles', and polygons' boundaries are counted as matching.
This is the default. "boundaries-excluded" Points on boxes',
circles', and polygons' boundaries are not counted as matching.
"boundaries-latitude-excluded" Points on boxes' latitude boundaries
are not counted as matching. "boundaries-longitude-excluded" Points
on boxes' longitude boundaries are not counted as matching.
"boundaries-south-excluded" Points on the boxes' southern
boundaries are not counted as matching. "boundaries-west-excluded"
Points on the boxes' western boundaries are not counted as
matching. "boundaries-north-excluded" Points on the boxes' northern
boundaries are not counted as matching. "boundaries-east-excluded"
Points on the boxes' eastern boundaries are not counted as
matching. "boundaries-circle-excluded" Points on circles' boundary
are not counted as matching. "boundaries-endpoints-excluded" Points
on linestrings' boundary (the endpoints) are not counted as
matching. "cached" Cache the results of this query in the list
cache. "uncached" Do not cache the results of this query in the
list cache. "score-function=function" Use the selected scoring
function. The score function may be: linearUse a linear function of
the difference between the specified query value and the matching
value in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $regions parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrence of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)CtsQueryExpr jsonPropertyPairGeospatialQuery(java.lang.String propertyName, java.lang.String latitudeName, java.lang.String longitudeName, ServerExpression region, java.lang.String options, double weight)
Provides a client interface to the cts:json-property-pair-geospatial-query server function.
propertyName - One or more parent property names
to match. When multiple names are specified, the query matches if
any name matches. (of xs:string)latitudeName - One or more latitude property names
to match. When multiple names are specified, the query matches if
any name matches; however, only the first matching latitude child
in any point instance will be checked. (of xs:string)longitudeName - One or more longitude property
names to match. When multiple names are specified, the query
matches if any name matches; however, only the first matching
longitude child in any point instance will be checked. (of xs:string)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)options - Options to this query. The default is
(). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system with degrees as the angular unit. wgs84/radiansThe WGS84
coordinate system with radians as the angular unit. wgs84/doubleThe
WGS84 coordinate system at double precision with degrees as the
angular unit. wgs84/radians/doubleThe WGS84 coordinate system at
double precision with radians as the angular unit. etrs89The ETRS89
coordinate system. etrs89/doubleThe ETRS89 coordinate system at
double precision. rawThe raw (unmapped) coordinate system.
raw/doubleThe raw coordinate system at double precision.
"precision=value" Use the coordinate system at the given precision.
Allowed values: float and double. "units=value" Measure distance
and the radii of circles in the specified units. Allowed values:
miles (default), km, feet, meters. "boundaries-included" Points on
boxes', circles', and polygons' boundaries are counted as matching.
This is the default. "boundaries-excluded" Points on boxes',
circles', and polygons' boundaries are not counted as matching.
"boundaries-latitude-excluded" Points on boxes' latitude boundaries
are not counted as matching. "boundaries-longitude-excluded" Points
on boxes' longitude boundaries are not counted as matching.
"boundaries-south-excluded" Points on the boxes' southern
boundaries are not counted as matching. "boundaries-west-excluded"
Points on the boxes' western boundaries are not counted as
matching. "boundaries-north-excluded" Points on the boxes' northern
boundaries are not counted as matching. "boundaries-east-excluded"
Points on the boxes' eastern boundaries are not counted as
matching. "boundaries-circle-excluded" Points on circles' boundary
are not counted as matching. "boundaries-endpoints-excluded" Points
on linestrings' boundary (the endpoints) are not counted as
matching. "cached" Cache the results of this query in the list
cache. "uncached" Do not cache the results of this query in the
list cache. "score-function=function" Use the selected scoring
function. The score function may be: linearUse a linear function of
the difference between the specified query value and the matching
value in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $regions parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrence of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)weight - A weight for this query. The default is
1.0. (of xs:double)CtsQueryExpr jsonPropertyPairGeospatialQuery(ServerExpression propertyName, ServerExpression latitudeName, ServerExpression longitudeName, ServerExpression region, ServerExpression options, ServerExpression weight)
Provides a client interface to the cts:json-property-pair-geospatial-query server function.
propertyName - One or more parent property names
to match. When multiple names are specified, the query matches if
any name matches. (of xs:string)latitudeName - One or more latitude property names
to match. When multiple names are specified, the query matches if
any name matches; however, only the first matching latitude child
in any point instance will be checked. (of xs:string)longitudeName - One or more longitude property
names to match. When multiple names are specified, the query
matches if any name matches; however, only the first matching
longitude child in any point instance will be checked. (of xs:string)region - One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches. (of cts:region)options - Options to this query. The default is
(). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system with degrees as the angular unit. wgs84/radiansThe WGS84
coordinate system with radians as the angular unit. wgs84/doubleThe
WGS84 coordinate system at double precision with degrees as the
angular unit. wgs84/radians/doubleThe WGS84 coordinate system at
double precision with radians as the angular unit. etrs89The ETRS89
coordinate system. etrs89/doubleThe ETRS89 coordinate system at
double precision. rawThe raw (unmapped) coordinate system.
raw/doubleThe raw coordinate system at double precision.
"precision=value" Use the coordinate system at the given precision.
Allowed values: float and double. "units=value" Measure distance
and the radii of circles in the specified units. Allowed values:
miles (default), km, feet, meters. "boundaries-included" Points on
boxes', circles', and polygons' boundaries are counted as matching.
This is the default. "boundaries-excluded" Points on boxes',
circles', and polygons' boundaries are not counted as matching.
"boundaries-latitude-excluded" Points on boxes' latitude boundaries
are not counted as matching. "boundaries-longitude-excluded" Points
on boxes' longitude boundaries are not counted as matching.
"boundaries-south-excluded" Points on the boxes' southern
boundaries are not counted as matching. "boundaries-west-excluded"
Points on the boxes' western boundaries are not counted as
matching. "boundaries-north-excluded" Points on the boxes' northern
boundaries are not counted as matching. "boundaries-east-excluded"
Points on the boxes' eastern boundaries are not counted as
matching. "boundaries-circle-excluded" Points on circles' boundary
are not counted as matching. "boundaries-endpoints-excluded" Points
on linestrings' boundary (the endpoints) are not counted as
matching. "cached" Cache the results of this query in the list
cache. "uncached" Do not cache the results of this query in the
list cache. "score-function=function" Use the selected scoring
function. The score function may be: linearUse a linear function of
the difference between the specified query value and the matching
value in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $regions parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrence of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)weight - A weight for this query. The default is
1.0. (of xs:double)CtsQueryExpr jsonPropertyRangeQuery(java.lang.String propertyName, java.lang.String operator, java.lang.String value)
Provides a client interface to the cts:json-property-range-query server function.
propertyName - One or more property name to match.
When multiple names are specified, the query matches if any name
matches. (of xs:string)operator - A comparison operator. Operators
include: "<" Match range index values less than $value. "<="
Match range index values less than or equal to $value. ">" Match
range index values greater than $value. ">=" Match range index
values greater than or equal to $value. "=" Match range index
values equal to $value. "!=" Match range index values not equal to
$value. (of xs:string)value - One or more property values to match. When
multiple values are specified, the query matches if any value
matches. The value must be a type for which there is a range index
defined. (of xs:anyAtomicType)CtsQueryExpr jsonPropertyRangeQuery(ServerExpression propertyName, ServerExpression operator, ServerExpression value)
Provides a client interface to the cts:json-property-range-query server function.
propertyName - One or more property name to match.
When multiple names are specified, the query matches if any name
matches. (of xs:string)operator - A comparison operator. Operators
include: "<" Match range index values less than $value. "<="
Match range index values less than or equal to $value. ">" Match
range index values greater than $value. ">=" Match range index
values greater than or equal to $value. "=" Match range index
values equal to $value. "!=" Match range index values not equal to
$value. (of xs:string)value - One or more property values to match. When
multiple values are specified, the query matches if any value
matches. The value must be a type for which there is a range index
defined. (of xs:anyAtomicType)CtsQueryExpr jsonPropertyRangeQuery(java.lang.String propertyName, java.lang.String operator, java.lang.String value, java.lang.String... options)
Provides a client interface to the cts:json-property-range-query server function.
propertyName - One or more property name to match.
When multiple names are specified, the query matches if any name
matches. (of xs:string)operator - A comparison operator. Operators
include: "<" Match range index values less than $value. "<="
Match range index values less than or equal to $value. ">" Match
range index values greater than $value. ">=" Match range index
values greater than or equal to $value. "=" Match range index
values equal to $value. "!=" Match range index values not equal to
$value. (of xs:string)value - One or more property values to match. When
multiple values are specified, the query matches if any value
matches. The value must be a type for which there is a range index
defined. (of xs:anyAtomicType)options - Options to this query. The default is
(). Options include: "collation=URI" Use the range index with the
collation specified by URI. If not specified, then the default
collation from the query is used. If a range index with the
specified collation does not exist, an error is thrown. "cached"
Cache the results of this query in the list cache. "uncached" Do
not cache the results of this query in the list cache.
"cached-incremental" When querying on a short date or dateTime
range, break the query into sub-queries on smaller ranges, and then
cache the results of each. See the Usage Notes for details.
"min-occurs=number" Specifies the minimum number of occurrences
required. If fewer that this number of words occur, the fragment
does not match. The default is 1. "max-occurs=number" Specifies the
maximum number of occurrences required. If more than this number of
words occur, the fragment does not match. The default is unbounded.
"score-function=function" Use the selected scoring function. The
score function may be: linearUse a linear function of the
difference between the specified query value and the matching value
in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $value parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrences of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)CtsQueryExpr jsonPropertyRangeQuery(ServerExpression propertyName, ServerExpression operator, ServerExpression value, ServerExpression options)
Provides a client interface to the cts:json-property-range-query server function.
propertyName - One or more property name to match.
When multiple names are specified, the query matches if any name
matches. (of xs:string)operator - A comparison operator. Operators
include: "<" Match range index values less than $value. "<="
Match range index values less than or equal to $value. ">" Match
range index values greater than $value. ">=" Match range index
values greater than or equal to $value. "=" Match range index
values equal to $value. "!=" Match range index values not equal to
$value. (of xs:string)value - One or more property values to match. When
multiple values are specified, the query matches if any value
matches. The value must be a type for which there is a range index
defined. (of xs:anyAtomicType)options - Options to this query. The default is
(). Options include: "collation=URI" Use the range index with the
collation specified by URI. If not specified, then the default
collation from the query is used. If a range index with the
specified collation does not exist, an error is thrown. "cached"
Cache the results of this query in the list cache. "uncached" Do
not cache the results of this query in the list cache.
"cached-incremental" When querying on a short date or dateTime
range, break the query into sub-queries on smaller ranges, and then
cache the results of each. See the Usage Notes for details.
"min-occurs=number" Specifies the minimum number of occurrences
required. If fewer that this number of words occur, the fragment
does not match. The default is 1. "max-occurs=number" Specifies the
maximum number of occurrences required. If more than this number of
words occur, the fragment does not match. The default is unbounded.
"score-function=function" Use the selected scoring function. The
score function may be: linearUse a linear function of the
difference between the specified query value and the matching value
in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $value parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrences of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)CtsQueryExpr jsonPropertyRangeQuery(java.lang.String propertyName, java.lang.String operator, java.lang.String value, java.lang.String options, double weight)
Provides a client interface to the cts:json-property-range-query server function.
propertyName - One or more property name to match.
When multiple names are specified, the query matches if any name
matches. (of xs:string)operator - A comparison operator. Operators
include: "<" Match range index values less than $value. "<="
Match range index values less than or equal to $value. ">" Match
range index values greater than $value. ">=" Match range index
values greater than or equal to $value. "=" Match range index
values equal to $value. "!=" Match range index values not equal to
$value. (of xs:string)value - One or more property values to match. When
multiple values are specified, the query matches if any value
matches. The value must be a type for which there is a range index
defined. (of xs:anyAtomicType)options - Options to this query. The default is
(). Options include: "collation=URI" Use the range index with the
collation specified by URI. If not specified, then the default
collation from the query is used. If a range index with the
specified collation does not exist, an error is thrown. "cached"
Cache the results of this query in the list cache. "uncached" Do
not cache the results of this query in the list cache.
"cached-incremental" When querying on a short date or dateTime
range, break the query into sub-queries on smaller ranges, and then
cache the results of each. See the Usage Notes for details.
"min-occurs=number" Specifies the minimum number of occurrences
required. If fewer that this number of words occur, the fragment
does not match. The default is 1. "max-occurs=number" Specifies the
maximum number of occurrences required. If more than this number of
words occur, the fragment does not match. The default is unbounded.
"score-function=function" Use the selected scoring function. The
score function may be: linearUse a linear function of the
difference between the specified query value and the matching value
in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $value parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrences of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)weight - A weight for this query. The default is
1.0. (of xs:double)CtsQueryExpr jsonPropertyRangeQuery(ServerExpression propertyName, ServerExpression operator, ServerExpression value, ServerExpression options, ServerExpression weight)
Provides a client interface to the cts:json-property-range-query server function.
propertyName - One or more property name to match.
When multiple names are specified, the query matches if any name
matches. (of xs:string)operator - A comparison operator. Operators
include: "<" Match range index values less than $value. "<="
Match range index values less than or equal to $value. ">" Match
range index values greater than $value. ">=" Match range index
values greater than or equal to $value. "=" Match range index
values equal to $value. "!=" Match range index values not equal to
$value. (of xs:string)value - One or more property values to match. When
multiple values are specified, the query matches if any value
matches. The value must be a type for which there is a range index
defined. (of xs:anyAtomicType)options - Options to this query. The default is
(). Options include: "collation=URI" Use the range index with the
collation specified by URI. If not specified, then the default
collation from the query is used. If a range index with the
specified collation does not exist, an error is thrown. "cached"
Cache the results of this query in the list cache. "uncached" Do
not cache the results of this query in the list cache.
"cached-incremental" When querying on a short date or dateTime
range, break the query into sub-queries on smaller ranges, and then
cache the results of each. See the Usage Notes for details.
"min-occurs=number" Specifies the minimum number of occurrences
required. If fewer that this number of words occur, the fragment
does not match. The default is 1. "max-occurs=number" Specifies the
maximum number of occurrences required. If more than this number of
words occur, the fragment does not match. The default is unbounded.
"score-function=function" Use the selected scoring function. The
score function may be: linearUse a linear function of the
difference between the specified query value and the matching value
in the index to calculate a score for this range query.
reciprocalUse a reciprocal function of the difference between the
specified query value and the matching value in the index to
calculate a score for this range query. zeroThis range query does
not contribute to the score. This is the default.
"slope-factor=number" Apply the given number as a scaling factor to
the slope of the scoring function. The default is 1.0. "synonym"
Specifies that all of the terms in the $value parameter are
considered synonyms for scoring purposes. The result is that
occurrences of more than one of the synonyms are scored as if there
are more occurrences of the same term (as opposed to having a
separate term that contributes to score). (of xs:string)weight - A weight for this query. The default is
1.0. (of xs:double)CtsReferenceExpr jsonPropertyReference(java.lang.String property)
Provides a client interface to the cts:json-property-reference server function.
property - A property name. (of xs:string)CtsReferenceExpr jsonPropertyReference(ServerExpression property)
Provides a client interface to the cts:json-property-reference server function.
property - A property name. (of xs:string)CtsReferenceExpr jsonPropertyReference(java.lang.String property, java.lang.String options)
Provides a client interface to the cts:json-property-reference server function.
property - A property name. (of xs:string)options - Options. The default is (). Options
include: "type=type" Use the lexicon with the type specified by
type (int, unsignedInt, long, unsignedLong, float, double, decimal,
dateTime, time, date, gYearMonth, gYear, gMonth, gDay,
yearMonthDuration, dayTimeDuration, string, anyURI, point, or
long-lat-point) "collation=URI" Use the lexicon with the collation
specified by URI. "nullable" Allow null values in tuples reported
from cts:value-tuples when using this lexicon. "unchecked" Read the
scalar type, collation and coordinate-system info only from the
input. Do not check the definition against the context database.
"coordinate-system=name" Create a reference to an index or lexicon
based on the specified coordinate system. Allowed values: "wgs84",
"wgs84/double", "raw", "raw/double". Only applicable if the
index/lexicon value type is point or long-lat-point.
"precision=value" Create a reference to an index or lexicon
configured with the specified geospatial precision. Allowed values:
float and double. Only applicable if the index/lexicon value type
is point or long-lat-point. This value takes precedence over the
precision implicit in the coordinate system name. (of xs:string)CtsReferenceExpr jsonPropertyReference(ServerExpression property, ServerExpression options)
Provides a client interface to the cts:json-property-reference server function.
property - A property name. (of xs:string)options - Options. The default is (). Options
include: "type=type" Use the lexicon with the type specified by
type (int, unsignedInt, long, unsignedLong, float, double, decimal,
dateTime, time, date, gYearMonth, gYear, gMonth, gDay,
yearMonthDuration, dayTimeDuration, string, anyURI, point, or
long-lat-point) "collation=URI" Use the lexicon with the collation
specified by URI. "nullable" Allow null values in tuples reported
from cts:value-tuples when using this lexicon. "unchecked" Read the
scalar type, collation and coordinate-system info only from the
input. Do not check the definition against the context database.
"coordinate-system=name" Create a reference to an index or lexicon
based on the specified coordinate system. Allowed values: "wgs84",
"wgs84/double", "raw", "raw/double". Only applicable if the
index/lexicon value type is point or long-lat-point.
"precision=value" Create a reference to an index or lexicon
configured with the specified geospatial precision. Allowed values:
float and double. Only applicable if the index/lexicon value type
is point or long-lat-point. This value takes precedence over the
precision implicit in the coordinate system name. (of xs:string)CtsQueryExpr jsonPropertyScopeQuery(java.lang.String propertyName, ServerExpression query)
Provides a client interface to the cts:json-property-scope-query server function.
propertyName - One or more property names to
match. When multiple names are specified, the query matches if any
name matches. (of xs:string)query - A query for the property to match. If a
string is entered, the string is treated as a cts:word-query of the
specified string. (of cts:query)CtsQueryExpr jsonPropertyScopeQuery(ServerExpression propertyName, ServerExpression query)
Provides a client interface to the cts:json-property-scope-query server function.
propertyName - One or more property names to
match. When multiple names are specified, the query matches if any
name matches. (of xs:string)query - A query for the property to match. If a
string is entered, the string is treated as a cts:word-query of the
specified string. (of cts:query)CtsQueryExpr jsonPropertyValueQuery(java.lang.String propertyName, java.lang.String value)
Provides a client interface to the cts:json-property-value-query server function.
propertyName - One or more property names to
match. When multiple names are specified, the query matches if any
name matches. (of xs:string)value - One or more property values to match. When
multiple values are specified, the query matches if any value
matches. The values can be strings, numbers or booleans to match
correspondingly typed nodes. If the value is the empty sequence,
the query matches null. (of xs:anyAtomicType)CtsQueryExpr jsonPropertyValueQuery(ServerExpression propertyName, ServerExpression value)
Provides a client interface to the cts:json-property-value-query server function.
propertyName - One or more property names to
match. When multiple names are specified, the query matches if any
name matches. (of xs:string)value - One or more property values to match. When
multiple values are specified, the query matches if any value
matches. The values can be strings, numbers or booleans to match
correspondingly typed nodes. If the value is the empty sequence,
the query matches null. (of xs:anyAtomicType)CtsQueryExpr jsonPropertyValueQuery(java.lang.String propertyName, java.lang.String value, java.lang.String... options)
Provides a client interface to the cts:json-property-value-query server function.
propertyName - One or more property names to
match. When multiple names are specified, the query matches if any
name matches. (of xs:string)value - One or more property values to match. When
multiple values are specified, the query matches if any value
matches. The values can be strings, numbers or booleans to match
correspondingly typed nodes. If the value is the empty sequence,
the query matches null. (of xs:anyAtomicType)options - Options to this query. The default is
(). Options include: "case-sensitive" A case-sensitive query.
"case-insensitive" A case-insensitive query. "diacritic-sensitive"
A diacritic-sensitive query. "diacritic-insensitive" A
diacritic-insensitive query. "punctuation-sensitive" A
punctuation-sensitive query. "punctuation-insensitive" A
punctuation-insensitive query. "whitespace-sensitive" A
whitespace-sensitive query. "whitespace-insensitive" A
whitespace-insensitive query. "stemmed" A stemmed query.
"unstemmed" An unstemmed query. "wildcarded" A wildcarded query.
"unwildcarded" An unwildcarded query. "exact" An exact match query.
Shorthand for "case-sensitive", "diacritic-sensitive",
"punctuation-sensitive", "whitespace-sensitive", "unstemmed", and
"unwildcarded". "lang=iso639code" Specifies the language of the
query. The iso639code code portion is case-insensitive, and uses
the languages specified by ISO 639. The default is specified in the
database configuration. "min-occurs=number" Specifies the minimum
number of occurrences required. If fewer that this number of words
occur, the fragment does not match. The default is 1.
"max-occurs=number" Specifies the maximum number of occurrences
required. If more than this number of words occur, the fragment
does not match. The default is unbounded. "synonym" Specifies that
all of the terms in the $text parameter are considered synonyms for
scoring purposes. The result is that occurrences of more than one
of the synonyms are scored as if there are more occurrences of the
same term (as opposed to having a separate term that contributes to
score). "lexicon-expansion-limit=number" Specifies the limit for
lexicon expansion. This puts a restriction on the number of lexicon
expansions that can be performed. If the limit is exceeded, the
server may raise an error depending on whether the "limit-check"
option is set. The default value for this option will be 4096.
"limit-check" Specifies that an error will be raised if the lexicon
expansion exceeds the specified limit. "no-limit-check" Specifies
that error will not be raised if the lexicon expansion exceeds the
specified limit. The server will try to resolve the wildcard. (of
xs:string)CtsQueryExpr jsonPropertyValueQuery(ServerExpression propertyName, ServerExpression value, ServerExpression options)
Provides a client interface to the cts:json-property-value-query server function.
propertyName - One or more property names to
match. When multiple names are specified, the query matches if any
name matches. (of xs:string)value - One or more property values to match. When
multiple values are specified, the query matches if any value
matches. The values can be strings, numbers or booleans to match
correspondingly typed nodes. If the value is the empty sequence,
the query matches null. (of xs:anyAtomicType)options - Options to this query. The default is
(). Options include: "case-sensitive" A case-sensitive query.
"case-insensitive" A case-insensitive query. "diacritic-sensitive"
A diacritic-sensitive query. "diacritic-insensitive" A
diacritic-insensitive query. "punctuation-sensitive" A
punctuation-sensitive query. "punctuation-insensitive" A
punctuation-insensitive query. "whitespace-sensitive" A
whitespace-sensitive query. "whitespace-insensitive" A
whitespace-insensitive query. "stemmed" A stemmed query.
"unstemmed" An unstemmed query. "wildcarded" A wildcarded query.
"unwildcarded" An unwildcarded query. "exact" An exact match query.
Shorthand for "case-sensitive", "diacritic-sensitive",
"punctuation-sensitive", "whitespace-sensitive", "unstemmed", and
"unwildcarded". "lang=iso639code" Specifies the language of the
query. The iso639code code portion is case-insensitive, and uses
the languages specified by ISO 639. The default is specified in the
database configuration. "min-occurs=number" Specifies the minimum
number of occurrences required. If fewer that this number of words
occur, the fragment does not match. The default is 1.
"max-occurs=number" Specifies the maximum number of occurrences
required. If more than this number of words occur, the fragment
does not match. The default is unbounded. "synonym" Specifies that
all of the terms in the $text parameter are considered synonyms for
scoring purposes. The result is that occurrences of more than one
of the synonyms are scored as if there are more occurrences of the
same term (as opposed to having a separate term that contributes to
score). "lexicon-expansion-limit=number" Specifies the limit for
lexicon expansion. This puts a restriction on the number of lexicon
expansions that can be performed. If the limit is exceeded, the
server may raise an error depending on whether the "limit-check"
option is set. The default value for this option will be 4096.
"limit-check" Specifies that an error will be raised if the lexicon
expansion exceeds the specified limit. "no-limit-check" Specifies
that error will not be raised if the lexicon expansion exceeds the
specified limit. The server will try to resolve the wildcard. (of
xs:string)CtsQueryExpr jsonPropertyValueQuery(java.lang.String propertyName, java.lang.String value, java.lang.String options, double weight)
Provides a client interface to the cts:json-property-value-query server function.
propertyName - One or more property names to
match. When multiple names are specified, the query matches if any
name matches. (of xs:string)value - One or more property values to match. When
multiple values are specified, the query matches if any value
matches. The values can be strings, numbers or booleans to match
correspondingly typed nodes. If the value is the empty sequence,
the query matches null. (of xs:anyAtomicType)options - Options to this query. The default is
(). Options include: "case-sensitive" A case-sensitive query.
"case-insensitive" A case-insensitive query. "diacritic-sensitive"
A diacritic-sensitive query. "diacritic-insensitive" A
diacritic-insensitive query. "punctuation-sensitive" A
punctuation-sensitive query. "punctuation-insensitive" A
punctuation-insensitive query. "whitespace-sensitive" A
whitespace-sensitive query. "whitespace-insensitive" A
whitespace-insensitive query. "stemmed" A stemmed query.
"unstemmed" An unstemmed query. "wildcarded" A wildcarded query.
"unwildcarded" An unwildcarded query. "exact" An exact match query.
Shorthand for "case-sensitive", "diacritic-sensitive",
"punctuation-sensitive", "whitespace-sensitive", "unstemmed", and
"unwildcarded". "lang=iso639code" Specifies the language of the
query. The iso639code code portion is case-insensitive, and uses
the languages specified by ISO 639. The default is specified in the
database configuration. "min-occurs=number" Specifies the minimum
number of occurrences required. If fewer that this number of words
occur, the fragment does not match. The default is 1.
"max-occurs=number" Specifies the maximum number of occurrences
required. If more than this number of words occur, the fragment
does not match. The default is unbounded. "synonym" Specifies that
all of the terms in the $text parameter are considered synonyms for
scoring purposes. The result is that occurrences of more than one
of the synonyms are scored as if there are more occurrences of the
same term (as opposed to having a separate term that contributes to
score). "lexicon-expansion-limit=number" Specifies the limit for
lexicon expansion. This puts a restriction on the number of lexicon
expansions that can be performed. If the limit is exceeded, the
server may raise an error depending on whether the "limit-check"
option is set. The default value for this option will be 4096.
"limit-check" Specifies that an error will be raised if the lexicon
expansion exceeds the specified limit. "no-limit-check" Specifies
that error will not be raised if the lexicon expansion exceeds the
specified limit. The server will try to resolve the wildcard. (of
xs:string)weight - A weight for this query. Higher weights
move search results up in the relevance order. The default is 1.0.
The weight should be between 64 and -16. Weights greater than 64
will have the same effect as a weight of 64. Weights less than the
absolute value of 0.0625 (between -0.0625 and 0.0625) are rounded
to 0, which means that they do not contribute to the score. (of
xs:double)CtsQueryExpr jsonPropertyValueQuery(ServerExpression propertyName, ServerExpression value, ServerExpression options, ServerExpression weight)
Provides a client interface to the cts:json-property-value-query server function.
propertyName - One or more property names to
match. When multiple names are specified, the query matches if any
name matches. (of xs:string)value - One or more property values to match. When
multiple values are specified, the query matches if any value
matches. The values can be strings, numbers or booleans to match
correspondingly typed nodes. If the value is the empty sequence,
the query matches null. (of xs:anyAtomicType)options - Options to this query. The default is
(). Options include: "case-sensitive" A case-sensitive query.
"case-insensitive" A case-insensitive query. "diacritic-sensitive"
A diacritic-sensitive query. "diacritic-insensitive" A
diacritic-insensitive query. "punctuation-sensitive" A
punctuation-sensitive query. "punctuation-insensitive" A
punctuation-insensitive query. "whitespace-sensitive" A
whitespace-sensitive query. "whitespace-insensitive" A
whitespace-insensitive query. "stemmed" A stemmed query.
"unstemmed" An unstemmed query. "wildcarded" A wildcarded query.
"unwildcarded" An unwildcarded query. "exact" An exact match query.
Shorthand for "case-sensitive", "diacritic-sensitive",
"punctuation-sensitive", "whitespace-sensitive", "unstemmed", and
"unwildcarded". "lang=iso639code" Specifies the language of the
query. The iso639code code portion is case-insensitive, and uses
the languages specified by ISO 639. The default is specified in the
database configuration. "min-occurs=number" Specifies the minimum
number of occurrences required. If fewer that this number of words
occur, the fragment does not match. The default is 1.
"max-occurs=number" Specifies the maximum number of occurrences
required. If more than this number of words occur, the fragment
does not match. The default is unbounded. "synonym" Specifies that
all of the terms in the $text parameter are considered synonyms for
scoring purposes. The result is that occurrences of more than one
of the synonyms are scored as if there are more occurrences of the
same term (as opposed to having a separate term that contributes to
score). "lexicon-expansion-limit=number" Specifies the limit for
lexicon expansion. This puts a restriction on the number of lexicon
expansions that can be performed. If the limit is exceeded, the
server may raise an error depending on whether the "limit-check"
option is set. The default value for this option will be 4096.
"limit-check" Specifies that an error will be raised if the lexicon
expansion exceeds the specified limit. "no-limit-check" Specifies
that error will not be raised if the lexicon expansion exceeds the
specified limit. The server will try to resolve the wildcard. (of
xs:string)weight - A weight for this query. Higher weights
move search results up in the relevance order. The default is 1.0.
The weight should be between 64 and -16. Weights greater than 64
will have the same effect as a weight of 64. Weights less than the
absolute value of 0.0625 (between -0.0625 and 0.0625) are rounded
to 0, which means that they do not contribute to the score. (of
xs:double)CtsQueryExpr jsonPropertyWordQuery(java.lang.String propertyName, java.lang.String text)
Provides a client interface to the cts:json-property-word-query server function.
propertyName - One or more JSON property names to
match. When multiple names are specified, the query matches if any
name matches. (of xs:string)text - Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches. (of xs:string)CtsQueryExpr jsonPropertyWordQuery(ServerExpression propertyName, ServerExpression text)
Provides a client interface to the cts:json-property-word-query server function.
propertyName - One or more JSON property names to
match. When multiple names are specified, the query matches if any
name matches. (of xs:string)text - Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches. (of xs:string)CtsQueryExpr jsonPropertyWordQuery(java.lang.String propertyName, java.lang.String text, java.lang.String... options)
Provides a client interface to the cts:json-property-word-query server function.
propertyName - One or more JSON property names to
match. When multiple names are specified, the query matches if any
name matches. (of xs:string)text - Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches. (of xs:string)options - Options to this query. The default is
(). Options include: "case-sensitive" A case-sensitive query.
"case-insensitive" A case-insensitive query. "diacritic-sensitive"
A diacritic-sensitive query. "diacritic-insensitive" A
diacritic-insensitive query. "punctuation-sensitive" A
punctuation-sensitive query. "punctuation-insensitive" A
punctuation-insensitive query. "whitespace-sensitive" A
whitespace-sensitive query. "whitespace-insensitive" A
whitespace-insensitive query. "stemmed" A stemmed query.
"unstemmed" An unstemmed query. "wildcarded" A wildcarded query.
"unwildcarded" An unwildcarded query. "exact" An exact match query.
Shorthand for "case-sensitive", "diacritic-sensitive",
"punctuation-sensitive", "whitespace-sensitive", "unstemmed", and
"unwildcarded". "lang=iso639code" Specifies the language of the
query. The iso639code code portion is case-insensitive, and uses
the languages specified by ISO 639. The default is specified in the
database configuration. "distance-weight=number" A weight applied
based on the minimum distance between matches of this query. Higher
weights add to the importance of proximity (as opposed to term
matches) when the relevance order is calculated. The default value
is 0.0 (no impact of proximity). The weight should be between 64
and -16. Weights greater than 64 will have the same effect as a
weight of 64. This parameter has no effect if the word positions
index is not enabled. This parameter has no effect on searches that
use score-simple, score-random, or score-zero (because those
scoring algorithms do not consider term frequency, proximity is
irrelevant). "min-occurs=number" Specifies the minimum number of
occurrences required. If fewer that this number of words occur, the
fragment does not match. The default is 1. "max-occurs=number"
Specifies the maximum number of occurrences required. If more than
this number of words occur, the fragment does not match. The
default is unbounded. "synonym" Specifies that all of the terms in
the $text parameter are considered synonyms for scoring purposes.
The result is that occurrences of more than one of the synonyms are
scored as if there are more occurrences of the same term (as
opposed to having a separate term that contributes to score).
"lexicon-expand=value" The value is one of full, prefix-postfix,
off, or heuristic (the default is heuristic). An option with a
value of lexicon-expand=full specifies that wildcards are resolved
by expanding the pattern to words in a lexicon (if there is one
available), and turning into a series of cts:word-queries, even if
this takes a long time to evaluate. An option with a value of
lexicon-expand=prefix-postfix specifies that wildcards are resolved
by expanding the pattern to the pre- and postfixes of the words in
the word lexicon (if there is one), and turning the query into a
series of character queries, even if it takes a long time to
evaluate. An option with a value of lexicon-expand=off specifies
that wildcards are only resolved by looking up character patterns
in the search pattern index, not in the lexicon. An option with a
value of lexicon-expand=heuristic, which is the default, specifies
that wildcards are resolved by using a series of internal rules,
such as estimating the number of lexicon entries that need to be
scanned, seeing if the estimate crosses certain thresholds, and (if
appropriate), using another way besides lexicon expansion to
resolve the query. * "lexicon-expansion-limit=number" Specifies the
limit for lexicon expansion. This puts a restriction on the number
of lexicon expansions that can be performed. If the limit is
exceeded, the server may raise an error depending on whether the
"limit-check" option is set. The default value for this option will
be 4096. "limit-check" Specifies that an error will be raised if
the lexicon expansion exceeds the specified limit. "no-limit-check"
Specifies that error will not be raised if the lexicon expansion
exceeds the specified limit. The server will try to resolve the
wildcard. (of xs:string)CtsQueryExpr jsonPropertyWordQuery(ServerExpression propertyName, ServerExpression text, ServerExpression options)
Provides a client interface to the cts:json-property-word-query server function.
propertyName - One or more JSON property names to
match. When multiple names are specified, the query matches if any
name matches. (of xs:string)text - Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches. (of xs:string)options - Options to this query. The default is
(). Options include: "case-sensitive" A case-sensitive query.
"case-insensitive" A case-insensitive query. "diacritic-sensitive"
A diacritic-sensitive query. "diacritic-insensitive" A
diacritic-insensitive query. "punctuation-sensitive" A
punctuation-sensitive query. "punctuation-insensitive" A
punctuation-insensitive query. "whitespace-sensitive" A
whitespace-sensitive query. "whitespace-insensitive" A
whitespace-insensitive query. "stemmed" A stemmed query.
"unstemmed" An unstemmed query. "wildcarded" A wildcarded query.
"unwildcarded" An unwildcarded query. "exact" An exact match query.
Shorthand for "case-sensitive", "diacritic-sensitive",
"punctuation-sensitive", "whitespace-sensitive", "unstemmed", and
"unwildcarded". "lang=iso639code" Specifies the language of the
query. The iso639code code portion is case-insensitive, and uses
the languages specified by ISO 639. The default is specified in the
database configuration. "distance-weight=number" A weight applied
based on the minimum distance between matches of this query. Higher
weights add to the importance of proximity (as opposed to term
matches) when the relevance order is calculated. The default value
is 0.0 (no impact of proximity). The weight should be between 64
and -16. Weights greater than 64 will have the same effect as a
weight of 64. This parameter has no effect if the word positions
index is not enabled. This parameter has no effect on searches that
use score-simple, score-random, or score-zero (because those
scoring algorithms do not consider term frequency, proximity is
irrelevant). "min-occurs=number" Specifies the minimum number of
occurrences required. If fewer that this number of words occur, the
fragment does not match. The default is 1. "max-occurs=number"
Specifies the maximum number of occurrences required. If more than
this number of words occur, the fragment does not match. The
default is unbounded. "synonym" Specifies that all of the terms in
the $text parameter are considered synonyms for scoring purposes.
The result is that occurrences of more than one of the synonyms are
scored as if there are more occurrences of the same term (as
opposed to having a separate term that contributes to score).
"lexicon-expand=value" The value is one of full, prefix-postfix,
off, or heuristic (the default is heuristic). An option with a
value of lexicon-expand=full specifies that wildcards are resolved
by expanding the pattern to words in a lexicon (if there is one
available), and turning into a series of cts:word-queries, even if
this takes a long time to evaluate. An option with a value of
lexicon-expand=prefix-postfix specifies that wildcards are resolved
by expanding the pattern to the pre- and postfixes of the words in
the word lexicon (if there is one), and turning the query into a
series of character queries, even if it takes a long time to
evaluate. An option with a value of lexicon-expand=off specifies
that wildcards are only resolved by looking up character patterns
in the search pattern index, not in the lexicon. An option with a
value of lexicon-expand=heuristic, which is the default, specifies
that wildcards are resolved by using a series of internal rules,
such as estimating the number of lexicon entries that need to be
scanned, seeing if the estimate crosses certain thresholds, and (if
appropriate), using another way besides lexicon expansion to
resolve the query. * "lexicon-expansion-limit=number" Specifies the
limit for lexicon expansion. This puts a restriction on the number
of lexicon expansions that can be performed. If the limit is
exceeded, the server may raise an error depending on whether the
"limit-check" option is set. The default value for this option will
be 4096. "limit-check" Specifies that an error will be raised if
the lexicon expansion exceeds the specified limit. "no-limit-check"
Specifies that error will not be raised if the lexicon expansion
exceeds the specified limit. The server will try to resolve the
wildcard. (of xs:string)CtsQueryExpr jsonPropertyWordQuery(java.lang.String propertyName, java.lang.String text, java.lang.String options, double weight)
Provides a client interface to the cts:json-property-word-query server function.
propertyName - One or more JSON property names to
match. When multiple names are specified, the query matches if any
name matches. (of xs:string)text - Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches. (of xs:string)options - Options to this query. The default is
(). Options include: "case-sensitive" A case-sensitive query.
"case-insensitive" A case-insensitive query. "diacritic-sensitive"
A diacritic-sensitive query. "diacritic-insensitive" A
diacritic-insensitive query. "punctuation-sensitive" A
punctuation-sensitive query. "punctuation-insensitive" A
punctuation-insensitive query. "whitespace-sensitive" A
whitespace-sensitive query. "whitespace-insensitive" A
whitespace-insensitive query. "stemmed" A stemmed query.
"unstemmed" An unstemmed query. "wildcarded" A wildcarded query.
"unwildcarded" An unwildcarded query. "exact" An exact match query.
Shorthand for "case-sensitive", "diacritic-sensitive",
"punctuation-sensitive", "whitespace-sensitive", "unstemmed", and
"unwildcarded". "lang=iso639code" Specifies the language of the
query. The iso639code code portion is case-insensitive, and uses
the languages specified by ISO 639. The default is specified in the
database configuration. "distance-weight=number" A weight applied
based on the minimum distance between matches of this query. Higher
weights add to the importance of proximity (as opposed to term
matches) when the relevance order is calculated. The default value
is 0.0 (no impact of proximity). The weight should be between 64
and -16. Weights greater than 64 will have the same effect as a
weight of 64. This parameter has no effect if the word positions
index is not enabled. This parameter has no effect on searches that
use score-simple, score-random, or score-zero (because those
scoring algorithms do not consider term frequency, proximity is
irrelevant). "min-occurs=number" Specifies the minimum number of
occurrences required. If fewer that this number of words occur, the
fragment does not match. The default is 1. "max-occurs=number"
Specifies the maximum number of occurrences required. If more than
this number of words occur, the fragment does not match. The
default is unbounded. "synonym" Specifies that all of the terms in
the $text parameter are considered synonyms for scoring purposes.
The result is that occurrences of more than one of the synonyms are
scored as if there are more occurrences of the same term (as
opposed to having a separate term that contributes to score).
"lexicon-expand=value" The value is one of full, prefix-postfix,
off, or heuristic (the default is heuristic). An option with a
value of lexicon-expand=full specifies that wildcards are resolved
by expanding the pattern to words in a lexicon (if there is one
available), and turning into a series of cts:word-queries, even if
this takes a long time to evaluate. An option with a value of
lexicon-expand=prefix-postfix specifies that wildcards are resolved
by expanding the pattern to the pre- and postfixes of the words in
the word lexicon (if there is one), and turning the query into a
series of character queries, even if it takes a long time to
evaluate. An option with a value of lexicon-expand=off specifies
that wildcards are only resolved by looking up character patterns
in the search pattern index, not in the lexicon. An option with a
value of lexicon-expand=heuristic, which is the default, specifies
that wildcards are resolved by using a series of internal rules,
such as estimating the number of lexicon entries that need to be
scanned, seeing if the estimate crosses certain thresholds, and (if
appropriate), using another way besides lexicon expansion to
resolve the query. * "lexicon-expansion-limit=number" Specifies the
limit for lexicon expansion. This puts a restriction on the number
of lexicon expansions that can be performed. If the limit is
exceeded, the server may raise an error depending on whether the
"limit-check" option is set. The default value for this option will
be 4096. "limit-check" Specifies that an error will be raised if
the lexicon expansion exceeds the specified limit. "no-limit-check"
Specifies that error will not be raised if the lexicon expansion
exceeds the specified limit. The server will try to resolve the
wildcard. (of xs:string)weight - A weight for this query. Higher weights
move search results up in the relevance order. The default is 1.0.
The weight should be between 64 and -16. Weights greater than 64
will have the same effect as a weight of 64. Weights less than the
absolute value of 0.0625 (between -0.0625 and 0.0625) are rounded
to 0, which means that they do not contribute to the score. (of
xs:double)CtsQueryExpr jsonPropertyWordQuery(ServerExpression propertyName, ServerExpression text, ServerExpression options, ServerExpression weight)
Provides a client interface to the