public interface CtsExpr
Modifier and Type | Method | Description |
---|---|---|
CtsQueryExpr |
afterQuery(XsUnsignedLongVal timestamp) |
Returns a query matching fragments committed
after a specified timestamp.
|
CtsQueryExpr |
andNotQuery(CtsQueryExpr positiveQuery,
CtsQueryExpr 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(CtsQuerySeqExpr queries) |
Returns a query specifying the intersection of
the matches specified by the sub-queries.
|
CtsQueryExpr |
andQuery(CtsQuerySeqExpr queries,
XsStringSeqVal options) |
Returns a query specifying the intersection of
the matches specified by the sub-queries.
|
CtsQueryExpr |
andQuery(CtsQuerySeqExpr queries,
java.lang.String options) |
Returns a query specifying the intersection of
the matches specified by the sub-queries.
|
CtsQueryExpr |
beforeQuery(XsUnsignedLongVal timestamp) |
Returns a query matching fragments committed
before or at a specified timestamp.
|
CtsQueryExpr |
boostQuery(CtsQueryExpr matchingQuery,
CtsQueryExpr boostingQuery) |
Returns a query specifying that matches to
matching-query should have their search relevance scores boosted if
they also match boosting-query.
|
ServerExpression |
box(double south,
double west, double north, double east) |
Returns a geospatial box value.
|
ServerExpression |
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.
|
ServerExpression |
boxSouth(ServerExpression box) |
Returns a box's southern boundary.
|
ServerExpression |
boxWest(ServerExpression box) |
Returns a box's western boundary.
|
ServerExpression |
circle(ServerExpression radius,
ServerExpression center) |
Returns a geospatial circle value.
|
ServerExpression |
circleCenter(ServerExpression circle) |
Returns a circle's center point.
|
ServerExpression |
circleRadius(ServerExpression circle) |
Returns a circle's radius.
|
CtsQueryExpr |
collectionQuery(XsStringSeqVal 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(XsStringSeqVal 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.
|
ServerExpression |
complexPolygon(ServerExpression outer,
ServerExpression inner) |
Returns a geospatial complex polygon
value.
|
CtsQueryExpr |
directoryQuery(XsStringSeqVal uris) |
Returns a query matching documents in the
directories with the given URIs.
|
CtsQueryExpr |
directoryQuery(XsStringSeqVal uris,
XsStringVal 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(CtsQueryExpr query) |
Returns a query that matches all documents where
query matches any document fragment.
|
CtsQueryExpr |
documentQuery(XsStringSeqVal 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(XsQNameSeqVal elementName,
XsQNameSeqVal latitudeName,
XsQNameSeqVal longitudeName,
CtsRegionSeqExpr 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(XsQNameSeqVal elementName,
XsQNameSeqVal latitudeName,
XsQNameSeqVal longitudeName,
CtsRegionSeqExpr region,
XsStringSeqVal 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(XsQNameSeqVal elementName,
XsQNameSeqVal latitudeName,
XsQNameSeqVal longitudeName,
CtsRegionSeqExpr region,
XsStringSeqVal options,
XsDoubleVal 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, CtsRegionSeqExpr 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, CtsRegionSeqExpr 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(XsQNameSeqVal elementName,
XsQNameSeqVal attributeName,
XsStringVal operator,
XsAnyAtomicTypeSeqVal value) |
Constructs a query that matches
element-attributes by name with a range-index entry equal to a
given value.
|
CtsQueryExpr |
elementAttributeRangeQuery(XsQNameSeqVal elementName,
XsQNameSeqVal attributeName,
XsStringVal operator,
XsAnyAtomicTypeSeqVal value,
XsStringSeqVal options) |
Constructs a query that matches
element-attributes by name with a range-index entry equal to a
given value.
|
CtsQueryExpr |
elementAttributeRangeQuery(XsQNameSeqVal elementName,
XsQNameSeqVal attributeName,
XsStringVal operator,
XsAnyAtomicTypeSeqVal value,
XsStringSeqVal options,
XsDoubleVal 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(XsQNameVal element,
XsQNameVal attribute) |
Creates a reference to an element attribute
value lexicon, for use as a parameter to cts:value-tuples.
|
CtsReferenceExpr |
elementAttributeReference(XsQNameVal element,
XsQNameVal attribute,
XsStringSeqVal 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(XsQNameSeqVal elementName,
XsQNameSeqVal attributeName,
XsStringSeqVal text) |
Returns a query matching elements by name with
attributes by name with text content equal a given phrase.
|
CtsQueryExpr |
elementAttributeValueQuery(XsQNameSeqVal elementName,
XsQNameSeqVal attributeName,
XsStringSeqVal text,
XsStringSeqVal options) |
Returns a query matching elements by name with
attributes by name with text content equal a given phrase.
|
CtsQueryExpr |
elementAttributeValueQuery(XsQNameSeqVal elementName,
XsQNameSeqVal attributeName,
XsStringSeqVal text,
XsStringSeqVal options,
XsDoubleVal 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(XsQNameSeqVal elementName,
XsQNameSeqVal attributeName,
XsStringSeqVal text) |
Returns a query matching elements by name with
attributes by name with text content containing a given
phrase.
|
CtsQueryExpr |
elementAttributeWordQuery(XsQNameSeqVal elementName,
XsQNameSeqVal attributeName,
XsStringSeqVal text,
XsStringSeqVal options) |
Returns a query matching elements by name with
attributes by name with text content containing a given
phrase.
|
CtsQueryExpr |
elementAttributeWordQuery(XsQNameSeqVal elementName,
XsQNameSeqVal attributeName,
XsStringSeqVal text,
XsStringSeqVal options,
XsDoubleVal 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(XsQNameSeqVal elementName,
XsQNameSeqVal childName,
CtsRegionSeqExpr 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(XsQNameSeqVal elementName,
XsQNameSeqVal childName,
CtsRegionSeqExpr region,
XsStringSeqVal 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(XsQNameSeqVal elementName,
XsQNameSeqVal childName,
CtsRegionSeqExpr region,
XsStringSeqVal options,
XsDoubleVal 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, CtsRegionSeqExpr 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, CtsRegionSeqExpr 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(XsQNameSeqVal elementName,
CtsRegionSeqExpr 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(XsQNameSeqVal elementName,
CtsRegionSeqExpr region,
XsStringSeqVal 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(XsQNameSeqVal elementName,
CtsRegionSeqExpr region,
XsStringSeqVal options,
XsDoubleVal 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,
CtsRegionSeqExpr 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,
CtsRegionSeqExpr 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(XsQNameSeqVal elementName,
XsQNameSeqVal latitudeName,
XsQNameSeqVal longitudeName,
CtsRegionSeqExpr 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(XsQNameSeqVal elementName,
XsQNameSeqVal latitudeName,
XsQNameSeqVal longitudeName,
CtsRegionSeqExpr region,
XsStringSeqVal 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(XsQNameSeqVal elementName,
XsQNameSeqVal latitudeName,
XsQNameSeqVal longitudeName,
CtsRegionSeqExpr region,
XsStringSeqVal options,
XsDoubleVal 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, CtsRegionSeqExpr 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, CtsRegionSeqExpr 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(XsQNameSeqVal elementName,
CtsQueryExpr 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,
CtsQueryExpr query) |
Constructs a query that matches elements by name
with the content constrained by the query given in the second
parameter.
|
CtsQueryExpr |
elementRangeQuery(XsQNameSeqVal elementName,
XsStringVal operator,
XsAnyAtomicTypeSeqVal value) |
Constructs a query that matches elements by name
with range index entry equal to a given value.
|
CtsQueryExpr |
elementRangeQuery(XsQNameSeqVal elementName,
XsStringVal operator,
XsAnyAtomicTypeSeqVal value,
XsStringSeqVal options) |
Constructs a query that matches elements by name
with range index entry equal to a given value.
|
CtsQueryExpr |
elementRangeQuery(XsQNameSeqVal elementName,
XsStringVal operator,
XsAnyAtomicTypeSeqVal value,
XsStringSeqVal options,
XsDoubleVal 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(XsQNameVal 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(XsQNameVal element,
XsStringSeqVal 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(XsQNameSeqVal elementName) |
Returns a query matching elements by name with
text content equal a given phrase.
|
CtsQueryExpr |
elementValueQuery(XsQNameSeqVal elementName,
XsStringSeqVal text) |
Returns a query matching elements by name with
text content equal a given phrase.
|
CtsQueryExpr |
elementValueQuery(XsQNameSeqVal elementName,
XsStringSeqVal text,
XsStringSeqVal options) |
Returns a query matching elements by name with
text content equal a given phrase.
|
CtsQueryExpr |
elementValueQuery(XsQNameSeqVal elementName,
XsStringSeqVal text,
XsStringSeqVal options,
XsDoubleVal 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(XsQNameSeqVal elementName,
XsStringSeqVal text) |
Returns a query matching elements by name with
text content containing a given phrase.
|
CtsQueryExpr |
elementWordQuery(XsQNameSeqVal elementName,
XsStringSeqVal text,
XsStringSeqVal options) |
Returns a query matching elements by name with
text content containing a given phrase.
|
CtsQueryExpr |
elementWordQuery(XsQNameSeqVal elementName,
XsStringSeqVal text,
XsStringSeqVal options,
XsDoubleVal 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(XsStringSeqVal fieldName,
XsStringVal operator,
XsAnyAtomicTypeSeqVal value) |
Returns a cts:query matching fields by name with
a range-index entry equal to a given value.
|
CtsQueryExpr |
fieldRangeQuery(XsStringSeqVal fieldName,
XsStringVal operator,
XsAnyAtomicTypeSeqVal value,
XsStringSeqVal options) |
Returns a cts:query matching fields by name with
a range-index entry equal to a given value.
|
CtsQueryExpr |
fieldRangeQuery(XsStringSeqVal fieldName,
XsStringVal operator,
XsAnyAtomicTypeSeqVal value,
XsStringSeqVal options,
XsDoubleVal 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(XsStringVal field) |
Creates a reference to a field value lexicon,
for use as a parameter to cts:value-tuples.
|
CtsReferenceExpr |
fieldReference(XsStringVal field,
XsStringSeqVal 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(XsStringSeqVal fieldName,
XsAnyAtomicTypeSeqVal text) |
Returns a query matching text content containing
a given value in the specified field.
|
CtsQueryExpr |
fieldValueQuery(XsStringSeqVal fieldName,
XsAnyAtomicTypeSeqVal text,
XsStringSeqVal options) |
Returns a query matching text content containing
a given value in the specified field.
|
CtsQueryExpr |
fieldValueQuery(XsStringSeqVal fieldName,
XsAnyAtomicTypeSeqVal text,
XsStringSeqVal options,
XsDoubleVal 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(XsStringSeqVal fieldName,
XsStringSeqVal text) |
Returns a query matching fields with text
content containing a given phrase.
|
CtsQueryExpr |
fieldWordQuery(XsStringSeqVal fieldName,
XsStringSeqVal text,
XsStringSeqVal options) |
Returns a query matching fields with text
content containing a given phrase.
|
CtsQueryExpr |
fieldWordQuery(XsStringSeqVal fieldName,
XsStringSeqVal text,
XsStringSeqVal options,
XsDoubleVal 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(XsStringVal pathExpression) |
Creates a reference to a geospatial path range
index, for use as a parameter to cts:value-tuples.
|
CtsReferenceExpr |
geospatialPathReference(XsStringVal pathExpression,
XsStringSeqVal options) |
Creates a reference to a geospatial path range
index, for use as a parameter to cts:value-tuples.
|
CtsReferenceExpr |
geospatialPathReference(XsStringVal pathExpression,
XsStringSeqVal 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(XsStringVal 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(XsStringVal pathExpression,
XsStringSeqVal 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(XsStringVal pathExpression,
XsStringSeqVal 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) |
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.
|
CtsQueryExpr |
geospatialRegionQuery(CtsReferenceSeqExpr reference,
XsStringVal operation,
CtsRegionSeqExpr region) |
Construct a query to match regions in documents
that satisfy a specified relationship relative to other
regions.
|
CtsQueryExpr |
geospatialRegionQuery(CtsReferenceSeqExpr reference,
XsStringVal operation,
CtsRegionSeqExpr region,
XsStringSeqVal options) |
Construct a query to match regions in documents
that satisfy a specified relationship relative to other
regions.
|
CtsQueryExpr |
geospatialRegionQuery(CtsReferenceSeqExpr reference,
XsStringVal operation,
CtsRegionSeqExpr region,
XsStringSeqVal options,
XsDoubleVal weight) |
Construct a query to match regions in documents
that satisfy a specified relationship relative to other
regions.
|
CtsQueryExpr |
geospatialRegionQuery(CtsReferenceSeqExpr 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(CtsReferenceSeqExpr reference,
java.lang.String operation, CtsRegionSeqExpr region,
java.lang.String... options) |
Construct a query to match regions in documents
that satisfy a specified relationship relative to other
regions.
|
CtsQueryExpr |
geospatialRegionQuery(CtsReferenceSeqExpr reference,
java.lang.String operation, CtsRegionSeqExpr region,
java.lang.String options, double weight) |
Construct a query to match regions in documents
that satisfy a specified relationship relative to other
regions.
|
CtsQueryExpr |
jsonPropertyChildGeospatialQuery(XsStringSeqVal propertyName,
XsStringSeqVal childName,
CtsRegionSeqExpr 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(XsStringSeqVal propertyName,
XsStringSeqVal childName,
CtsRegionSeqExpr region,
XsStringSeqVal 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(XsStringSeqVal propertyName,
XsStringSeqVal childName,
CtsRegionSeqExpr region,
XsStringSeqVal options,
XsDoubleVal 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, CtsRegionSeqExpr 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, CtsRegionSeqExpr 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(XsStringSeqVal propertyName,
CtsRegionSeqExpr 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(XsStringSeqVal propertyName,
CtsRegionSeqExpr region,
XsStringSeqVal 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(XsStringSeqVal propertyName,
CtsRegionSeqExpr region,
XsStringSeqVal options,
XsDoubleVal 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,
CtsRegionSeqExpr 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,
CtsRegionSeqExpr 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(XsStringSeqVal propertyName,
XsStringSeqVal latitudeName,
XsStringSeqVal longitudeName,
CtsRegionSeqExpr 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(XsStringSeqVal propertyName,
XsStringSeqVal latitudeName,
XsStringSeqVal longitudeName,
CtsRegionSeqExpr region,
XsStringSeqVal 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(XsStringSeqVal propertyName,
XsStringSeqVal latitudeName,
XsStringSeqVal longitudeName,
CtsRegionSeqExpr region,
XsStringSeqVal options,
XsDoubleVal 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, CtsRegionSeqExpr 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, CtsRegionSeqExpr 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(XsStringSeqVal propertyName,
XsStringVal operator,
XsAnyAtomicTypeSeqVal value) |
Returns a cts:query matching JSON properties by
name with a range-index entry equal to a given value.
|
CtsQueryExpr |
jsonPropertyRangeQuery(XsStringSeqVal propertyName,
XsStringVal operator,
XsAnyAtomicTypeSeqVal value,
XsStringSeqVal options) |
Returns a cts:query matching JSON properties by
name with a range-index entry equal to a given value.
|
CtsQueryExpr |
jsonPropertyRangeQuery(XsStringSeqVal propertyName,
XsStringVal operator,
XsAnyAtomicTypeSeqVal value,
XsStringSeqVal options,
XsDoubleVal 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(XsStringVal property) |
Creates a reference to a JSON property value
lexicon, for use as a parameter to cts:value-tuples.
|
CtsReferenceExpr |
jsonPropertyReference(XsStringVal property,
XsStringSeqVal 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(XsStringSeqVal propertyName,
CtsQueryExpr 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,
CtsQueryExpr 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(XsStringSeqVal propertyName,
XsAnyAtomicTypeSeqVal value) |
Returns a query matching JSON properties by name
with value equal the given value.
|
CtsQueryExpr |
jsonPropertyValueQuery(XsStringSeqVal propertyName,
XsAnyAtomicTypeSeqVal value,
XsStringSeqVal options) |
Returns a query matching JSON properties by name
with value equal the given value.
|
CtsQueryExpr |
jsonPropertyValueQuery(XsStringSeqVal propertyName,
XsAnyAtomicTypeSeqVal value,
XsStringSeqVal options,
XsDoubleVal 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(XsStringSeqVal propertyName,
XsStringSeqVal text) |
Returns a query matching JSON properties by name
with text content containing a given phrase.
|
CtsQueryExpr |
jsonPropertyWordQuery(XsStringSeqVal propertyName,
XsStringSeqVal text,
XsStringSeqVal options) |
Returns a query matching JSON properties by name
with text content containing a given phrase.
|
CtsQueryExpr |
jsonPropertyWordQuery(XsStringSeqVal propertyName,
XsStringSeqVal text,
XsStringSeqVal options,
XsDoubleVal 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(CtsQueryExpr query) |
Returns a query that matches all documents where
query matches document-locks.
|
CtsQueryExpr |
lsqtQuery(XsStringVal temporalCollection) |
Returns only documents before LSQT or a
timestamp before LSQT for stable query results.
|
CtsQueryExpr |
lsqtQuery(XsStringVal temporalCollection,
XsDateTimeVal timestamp) |
Returns only documents before LSQT or a
timestamp before LSQT for stable query results.
|
CtsQueryExpr |
lsqtQuery(XsStringVal temporalCollection,
XsDateTimeVal timestamp,
XsStringSeqVal options) |
Returns only documents before LSQT or a
timestamp before LSQT for stable query results.
|
CtsQueryExpr |
lsqtQuery(XsStringVal temporalCollection,
XsDateTimeVal timestamp,
XsStringSeqVal options,
XsDoubleVal 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(CtsQuerySeqExpr queries) |
Returns a query matching all of the specified
queries, where the matches occur within the specified distance from
each other.
|
CtsQueryExpr |
nearQuery(CtsQuerySeqExpr 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(CtsQuerySeqExpr 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(CtsQuerySeqExpr 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(CtsQuerySeqExpr queries,
XsDoubleVal distance) |
Returns a query matching all of the specified
queries, where the matches occur within the specified distance from
each other.
|
CtsQueryExpr |
nearQuery(CtsQuerySeqExpr queries,
XsDoubleVal distance,
XsStringSeqVal options) |
Returns a query matching all of the specified
queries, where the matches occur within the specified distance from
each other.
|
CtsQueryExpr |
nearQuery(CtsQuerySeqExpr queries,
XsDoubleVal distance,
XsStringSeqVal options,
XsDoubleVal weight) |
Returns a query matching all of the specified
queries, where the matches occur within the specified distance from
each other.
|
CtsQueryExpr |
notInQuery(CtsQueryExpr positiveQuery,
CtsQueryExpr negativeQuery) |
Returns a query matching the first subquery,
where those matches do not occur within 0 distance of the other
query.
|
CtsQueryExpr |
notQuery(CtsQueryExpr 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(CtsQuerySeqExpr queries) |
Returns a query specifying the union of the
matches specified by the sub-queries.
|
CtsQueryExpr |
orQuery(CtsQuerySeqExpr queries,
XsStringSeqVal options) |
Returns a query specifying the union of the
matches specified by the sub-queries.
|
CtsQueryExpr |
orQuery(CtsQuerySeqExpr 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(XsStringSeqVal pathExpression,
CtsRegionSeqExpr 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(XsStringSeqVal pathExpression,
CtsRegionSeqExpr region,
XsStringSeqVal 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(XsStringSeqVal pathExpression,
CtsRegionSeqExpr region,
XsStringSeqVal options,
XsDoubleVal 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,
CtsRegionSeqExpr 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,
CtsRegionSeqExpr 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(XsStringSeqVal pathName,
XsStringVal operator,
XsAnyAtomicTypeSeqVal 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(XsStringSeqVal pathName,
XsStringVal operator,
XsAnyAtomicTypeSeqVal value,
XsStringSeqVal 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(XsStringSeqVal pathName,
XsStringVal operator,
XsAnyAtomicTypeSeqVal value,
XsStringSeqVal options,
XsDoubleVal 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(XsStringVal pathExpression) |
Creates a reference to a path value lexicon, for
use as a parameter to cts:value-tuples.
|
CtsReferenceExpr |
pathReference(XsStringVal pathExpression,
XsStringSeqVal options) |
Creates a reference to a path value lexicon, for
use as a parameter to cts:value-tuples.
|
CtsReferenceExpr |
pathReference(XsStringVal pathExpression,
XsStringSeqVal 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(XsDateTimeVal start,
XsDateTimeVal 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(XsStringVal axis1,
XsStringVal operator,
XsStringVal axis2) |
Returns a cts:query matching documents that have
relevant pair of period values.
|
CtsQueryExpr |
periodCompareQuery(XsStringVal axis1,
XsStringVal operator,
XsStringVal axis2,
XsStringSeqVal 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(XsStringSeqVal axis,
XsStringVal operator) |
Returns a cts:query matching axis by name with a
period value with an operator.
|
CtsQueryExpr |
periodRangeQuery(XsStringSeqVal axis,
XsStringVal operator,
CtsPeriodSeqExpr period) |
Returns a cts:query matching axis by name with a
period value with an operator.
|
CtsQueryExpr |
periodRangeQuery(XsStringSeqVal axis,
XsStringVal operator,
CtsPeriodSeqExpr period,
XsStringSeqVal 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, CtsPeriodSeqExpr 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.
|
ServerExpression |
point(double latitude,
double longitude) |
Returns a point value.
|
ServerExpression |
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.
|
ServerExpression |
polygon(ServerExpression vertices) |
Returns a geospatial polygon value.
|
CtsQueryExpr |
propertiesFragmentQuery(CtsQueryExpr 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(CtsReferenceSeqExpr index,
XsStringVal operator,
XsAnyAtomicTypeSeqVal value) |
Returns a cts:query matching specified nodes
with a range-index entry compared to a given value.
|
CtsQueryExpr |
rangeQuery(CtsReferenceSeqExpr index,
XsStringVal operator,
XsAnyAtomicTypeSeqVal value,
XsStringSeqVal options) |
Returns a cts:query matching specified nodes
with a range-index entry compared to a given value.
|
CtsQueryExpr |
rangeQuery(CtsReferenceSeqExpr index,
XsStringVal operator,
XsAnyAtomicTypeSeqVal value,
XsStringSeqVal options,
XsDoubleVal weight) |
Returns a cts:query matching specified nodes
with a range-index entry compared to a given value.
|
CtsQueryExpr |
rangeQuery(CtsReferenceSeqExpr 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(CtsReferenceSeqExpr 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(CtsReferenceSeqExpr 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(XsAnyAtomicTypeSeqVal subject,
XsAnyAtomicTypeSeqVal predicate,
XsAnyAtomicTypeSeqVal object) |
Returns a cts:query matching triples with a
triple index entry equal to the given values.
|
CtsQueryExpr |
tripleRangeQuery(XsAnyAtomicTypeSeqVal subject,
XsAnyAtomicTypeSeqVal predicate,
XsAnyAtomicTypeSeqVal object,
XsStringSeqVal operator) |
Returns a cts:query matching triples with a
triple index entry equal to the given values.
|
CtsQueryExpr |
tripleRangeQuery(XsAnyAtomicTypeSeqVal subject,
XsAnyAtomicTypeSeqVal predicate,
XsAnyAtomicTypeSeqVal object,
XsStringSeqVal operator,
XsStringSeqVal options) |
Returns a cts:query matching triples with a
triple index entry equal to the given values.
|
CtsQueryExpr |
tripleRangeQuery(XsAnyAtomicTypeSeqVal subject,
XsAnyAtomicTypeSeqVal predicate,
XsAnyAtomicTypeSeqVal object,
XsStringSeqVal operator,
XsStringSeqVal options,
XsDoubleVal 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(XsStringSeqVal text) |
Returns a query matching text content containing
a given phrase.
|
CtsQueryExpr |
wordQuery(XsStringSeqVal text,
XsStringSeqVal options) |
Returns a query matching text content containing
a given phrase.
|
CtsQueryExpr |
wordQuery(XsStringSeqVal text,
XsStringSeqVal options,
XsDoubleVal 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(XsUnsignedLongVal timestamp)
Provides a client interface to the cts:after-query server function.
timestamp
- A commit timestamp. Database fragments
committed after this timestamp are matched.CtsQueryExpr andNotQuery(CtsQueryExpr positiveQuery, CtsQueryExpr negativeQuery)
Provides a client interface to the cts:and-not-query server function.
positiveQuery
- A positive query, specifying the
search results filtered in.negativeQuery
- A negative query, specifying the
search results to filter out.CtsQueryExpr andQuery(CtsQueryExpr... queries)
Provides a client interface to the cts:and-query server function.
queries
- A sequence of sub-queries.CtsQueryExpr andQuery(CtsQuerySeqExpr queries)
Provides a client interface to the cts:and-query server function.
queries
- A sequence of sub-queries.CtsQueryExpr andQuery(CtsQuerySeqExpr queries, java.lang.String options)
Provides a client interface to the cts:and-query server function.
queries
- A sequence of sub-queries.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.CtsQueryExpr andQuery(CtsQuerySeqExpr queries, XsStringSeqVal options)
Provides a client interface to the cts:and-query server function.
queries
- A sequence of sub-queries.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.CtsQueryExpr beforeQuery(XsUnsignedLongVal timestamp)
Provides a client interface to the cts:before-query server function.
timestamp
- A commit timestamp. Database fragments
committed before this timestamp are matched.CtsQueryExpr boostQuery(CtsQueryExpr matchingQuery, CtsQueryExpr boostingQuery)
Provides a client interface to the cts:boost-query server function.
matchingQuery
- A sub-query that is used for match
and scoring.boostingQuery
- A sub-query that is used only for
boosting score.ServerExpression box(double south, double west, double north, double east)
Provides a client interface to the cts:box server function.
ServerExpression 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)ServerExpression 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)ServerExpression 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.
uris
- One or more collection URIs. A document
matches the query if it is in at least one of these
collections.CtsQueryExpr collectionQuery(XsStringSeqVal uris)
Provides a client interface to the cts:collection-query server function.
uris
- One or more collection URIs. A document
matches the query if it is in at least one of these
collections.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.CtsReferenceExpr collectionReference(XsStringSeqVal 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.ServerExpression 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 innner (hole) polygons. (of cts:polygon)CtsQueryExpr directoryQuery(java.lang.String uris)
Provides a client interface to the cts:directory-query server function.
uris
- One or more directory URIs.CtsQueryExpr directoryQuery(XsStringSeqVal uris)
Provides a client interface to the cts:directory-query server function.
uris
- One or more directory URIs.CtsQueryExpr directoryQuery(java.lang.String uris, java.lang.String depth)
Provides a client interface to the cts:directory-query server function.
uris
- One or more directory URIs.depth
- "1" for immediate children, "infinity" for
all. If not supplied, depth is "1".CtsQueryExpr directoryQuery(XsStringSeqVal uris, XsStringVal depth)
Provides a client interface to the cts:directory-query server function.
uris
- One or more directory URIs.depth
- "1" for immediate children, "infinity" for
all. If not supplied, depth is "1".CtsQueryExpr documentFragmentQuery(CtsQueryExpr query)
Provides a client interface to the cts:document-fragment-query server function.
query
- A query to be matched against any document
fragment.CtsQueryExpr documentQuery(java.lang.String uris)
Provides a client interface to the cts:document-query server function.
uris
- One or more document URIs.CtsQueryExpr documentQuery(XsStringSeqVal uris)
Provides a client interface to the cts:document-query server function.
uris
- One or more document URIs.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.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.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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.CtsQueryExpr elementAttributePairGeospatialQuery(XsQNameSeqVal elementName, XsQNameSeqVal latitudeName, XsQNameSeqVal longitudeName, CtsRegionSeqExpr 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.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.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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.CtsQueryExpr elementAttributePairGeospatialQuery(java.lang.String elementName, java.lang.String latitudeName, java.lang.String longitudeName, CtsRegionSeqExpr 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.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.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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.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. wgs84/doubleThe WGS84 coordinate system at double
precision. 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
occurances of more than one of the synonyms are scored as if there
are more occurance of the same term (as opposed to having a
separate term that contributes to score).CtsQueryExpr elementAttributePairGeospatialQuery(XsQNameSeqVal elementName, XsQNameSeqVal latitudeName, XsQNameSeqVal longitudeName, CtsRegionSeqExpr region, XsStringSeqVal 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.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.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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.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. wgs84/doubleThe WGS84 coordinate system at double
precision. 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
occurances of more than one of the synonyms are scored as if there
are more occurance of the same term (as opposed to having a
separate term that contributes to score).CtsQueryExpr elementAttributePairGeospatialQuery(java.lang.String elementName, java.lang.String latitudeName, java.lang.String longitudeName, CtsRegionSeqExpr 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.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.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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.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. wgs84/doubleThe WGS84 coordinate system at double
precision. 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
occurances of more than one of the synonyms are scored as if there
are more occurance of the same term (as opposed to having a
separate term that contributes to score).weight
- A weight for this query. The default is
1.0.CtsQueryExpr elementAttributePairGeospatialQuery(XsQNameSeqVal elementName, XsQNameSeqVal latitudeName, XsQNameSeqVal longitudeName, CtsRegionSeqExpr region, XsStringSeqVal options, XsDoubleVal 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.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.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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.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. wgs84/doubleThe WGS84 coordinate system at double
precision. 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
occurances of more than one of the synonyms are scored as if there
are more occurance of the same term (as opposed to having a
separate term that contributes to score).weight
- A weight for this query. The default is
1.0.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.attributeName
- One or more attribute QNames to
match. When multiple QNames are specified, the query matches if any
QName matches.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.value
- Some values to match. When multiple values
are specified, the query matches if any value matches.CtsQueryExpr elementAttributeRangeQuery(XsQNameSeqVal elementName, XsQNameSeqVal attributeName, XsStringVal operator, XsAnyAtomicTypeSeqVal 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.attributeName
- One or more attribute QNames to
match. When multiple QNames are specified, the query matches if any
QName matches.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.value
- Some values to match. When multiple values
are specified, the query matches if any value matches.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.attributeName
- One or more attribute QNames to
match. When multiple QNames are specified, the query matches if any
QName matches.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.value
- Some values to match. When multiple values
are specified, the query matches if any value matches.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).CtsQueryExpr elementAttributeRangeQuery(XsQNameSeqVal elementName, XsQNameSeqVal attributeName, XsStringVal operator, XsAnyAtomicTypeSeqVal value, XsStringSeqVal 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.attributeName
- One or more attribute QNames to
match. When multiple QNames are specified, the query matches if any
QName matches.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.value
- Some values to match. When multiple values
are specified, the query matches if any value matches.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).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.attributeName
- One or more attribute QNames to
match. When multiple QNames are specified, the query matches if any
QName matches.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.value
- Some values to match. When multiple values
are specified, the query matches if any value matches.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).weight
- A weight for this query. The default is
1.0.CtsQueryExpr elementAttributeRangeQuery(XsQNameSeqVal elementName, XsQNameSeqVal attributeName, XsStringVal operator, XsAnyAtomicTypeSeqVal value, XsStringSeqVal options, XsDoubleVal 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.attributeName
- One or more attribute QNames to
match. When multiple QNames are specified, the query matches if any
QName matches.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.value
- Some values to match. When multiple values
are specified, the query matches if any value matches.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).weight
- A weight for this query. The default is
1.0.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.attribute
- An attribute QName.CtsReferenceExpr elementAttributeReference(XsQNameVal element, XsQNameVal attribute)
Provides a client interface to the cts:element-attribute-reference server function.
element
- An element QName.attribute
- An attribute 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.attribute
- An attribute 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.CtsReferenceExpr elementAttributeReference(XsQNameVal element, XsQNameVal attribute, XsStringSeqVal options)
Provides a client interface to the cts:element-attribute-reference server function.
element
- An element QName.attribute
- An attribute 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.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.attributeName
- One or more attribute QNames to
match. When multiple QNames are specified, the query matches if any
QName matches.text
- One or more attribute values to match. When
multiple strings are specified, the query matches if any string
matches.CtsQueryExpr elementAttributeValueQuery(XsQNameSeqVal elementName, XsQNameSeqVal attributeName, XsStringSeqVal 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.attributeName
- One or more attribute QNames to
match. When multiple QNames are specified, the query matches if any
QName matches.text
- One or more attribute values to match. When
multiple strings are specified, the query matches if any string
matches.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.attributeName
- One or more attribute QNames to
match. When multiple QNames are specified, the query matches if any
QName matches.text
- One or more attribute values to match. When
multiple strings are specified, the query matches if any string
matches.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.CtsQueryExpr elementAttributeValueQuery(XsQNameSeqVal elementName, XsQNameSeqVal attributeName, XsStringSeqVal text, XsStringSeqVal 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.attributeName
- One or more attribute QNames to
match. When multiple QNames are specified, the query matches if any
QName matches.text
- One or more attribute values to match. When
multiple strings are specified, the query matches if any string
matches.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.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.attributeName
- One or more attribute QNames to
match. When multiple QNames are specified, the query matches if any
QName matches.text
- One or more attribute values to match. When
multiple strings are specified, the query matches if any string
matches.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.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.CtsQueryExpr elementAttributeValueQuery(XsQNameSeqVal elementName, XsQNameSeqVal attributeName, XsStringSeqVal text, XsStringSeqVal options, XsDoubleVal 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.attributeName
- One or more attribute QNames to
match. When multiple QNames are specified, the query matches if any
QName matches.text
- One or more attribute values to match. When
multiple strings are specified, the query matches if any string
matches.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.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.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.attributeName
- One or more attribute QNames to
match. When multiple QNames are specified, the query matches if any
QName matches.text
- Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches.CtsQueryExpr elementAttributeWordQuery(XsQNameSeqVal elementName, XsQNameSeqVal attributeName, XsStringSeqVal 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.attributeName
- One or more attribute QNames to
match. When multiple QNames are specified, the query matches if any
QName matches.text
- Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches.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.attributeName
- One or more attribute QNames to
match. When multiple QNames are specified, the query matches if any
QName matches.text
- Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches.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.CtsQueryExpr elementAttributeWordQuery(XsQNameSeqVal elementName, XsQNameSeqVal attributeName, XsStringSeqVal text, XsStringSeqVal 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.attributeName
- One or more attribute QNames to
match. When multiple QNames are specified, the query matches if any
QName matches.text
- Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches.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.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.attributeName
- One or more attribute QNames to
match. When multiple QNames are specified, the query matches if any
QName matches.text
- Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches.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.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.CtsQueryExpr elementAttributeWordQuery(XsQNameSeqVal elementName, XsQNameSeqVal attributeName, XsStringSeqVal text, XsStringSeqVal options, XsDoubleVal 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.attributeName
- One or more attribute QNames to
match. When multiple QNames are specified, the query matches if any
QName matches.text
- Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches.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.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.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.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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.CtsQueryExpr elementChildGeospatialQuery(XsQNameSeqVal elementName, XsQNameSeqVal childName, CtsRegionSeqExpr 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.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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.CtsQueryExpr elementChildGeospatialQuery(java.lang.String elementName, java.lang.String childName, CtsRegionSeqExpr 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.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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.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. wgs84/doubleThe WGS84 coordinate system at double
precision. 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
occurances of more than one of the synonyms are scored as if there
are more occurance of the same term (as opposed to having a
separate term that contributes to score).CtsQueryExpr elementChildGeospatialQuery(XsQNameSeqVal elementName, XsQNameSeqVal childName, CtsRegionSeqExpr region, XsStringSeqVal 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.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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.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. wgs84/doubleThe WGS84 coordinate system at double
precision. 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
occurances of more than one of the synonyms are scored as if there
are more occurance of the same term (as opposed to having a
separate term that contributes to score).CtsQueryExpr elementChildGeospatialQuery(java.lang.String elementName, java.lang.String childName, CtsRegionSeqExpr 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.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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.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. wgs84/doubleThe WGS84 coordinate system at double
precision. 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
occurances of more than one of the synonyms are scored as if there
are more occurance of the same term (as opposed to having a
separate term that contributes to score).weight
- A weight for this query. The default is
1.0.CtsQueryExpr elementChildGeospatialQuery(XsQNameSeqVal elementName, XsQNameSeqVal childName, CtsRegionSeqExpr region, XsStringSeqVal options, XsDoubleVal 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.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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.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. wgs84/doubleThe WGS84 coordinate system at double
precision. 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
occurances of more than one of the synonyms are scored as if there
are more occurance of the same term (as opposed to having a
separate term that contributes to score).weight
- A weight for this query. The default is
1.0.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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.CtsQueryExpr elementGeospatialQuery(XsQNameSeqVal elementName, CtsRegionSeqExpr 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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.CtsQueryExpr elementGeospatialQuery(java.lang.String elementName, CtsRegionSeqExpr 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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.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. wgs84/doubleThe WGS84 coordinate system at double
precision. 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
occurances of more than one of the synonyms are scored as if there
are more occurance of the same term (as opposed to having a
separate term that contributes to score).CtsQueryExpr elementGeospatialQuery(XsQNameSeqVal elementName, CtsRegionSeqExpr region, XsStringSeqVal 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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.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. wgs84/doubleThe WGS84 coordinate system at double
precision. 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
occurances of more than one of the synonyms are scored as if there
are more occurance of the same term (as opposed to having a
separate term that contributes to score).CtsQueryExpr elementGeospatialQuery(java.lang.String elementName, CtsRegionSeqExpr 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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.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. wgs84/doubleThe WGS84 coordinate system at double
precision. 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
occurances of more than one of the synonyms are scored as if there
are more occurance of the same term (as opposed to having a
separate term that contributes to score).weight
- A weight for this query. The default is
1.0.CtsQueryExpr elementGeospatialQuery(XsQNameSeqVal elementName, CtsRegionSeqExpr region, XsStringSeqVal options, XsDoubleVal 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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.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. wgs84/doubleThe WGS84 coordinate system at double
precision. 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
occurances of more than one of the synonyms are scored as if there
are more occurance of the same term (as opposed to having a
separate term that contributes to score).weight
- A weight for this query. The default is
1.0.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.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.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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.CtsQueryExpr elementPairGeospatialQuery(XsQNameSeqVal elementName, XsQNameSeqVal latitudeName, XsQNameSeqVal longitudeName, CtsRegionSeqExpr 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.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.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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.CtsQueryExpr elementPairGeospatialQuery(java.lang.String elementName, java.lang.String latitudeName, java.lang.String longitudeName, CtsRegionSeqExpr 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.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.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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.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. wgs84/doubleThe WGS84 coordinate system at double
precision. 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
occurances of more than one of the synonyms are scored as if there
are more occurance of the same term (as opposed to having a
separate term that contributes to score).CtsQueryExpr elementPairGeospatialQuery(XsQNameSeqVal elementName, XsQNameSeqVal latitudeName, XsQNameSeqVal longitudeName, CtsRegionSeqExpr region, XsStringSeqVal 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.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.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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.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. wgs84/doubleThe WGS84 coordinate system at double
precision. 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
occurances of more than one of the synonyms are scored as if there
are more occurance of the same term (as opposed to having a
separate term that contributes to score).CtsQueryExpr elementPairGeospatialQuery(java.lang.String elementName, java.lang.String latitudeName, java.lang.String longitudeName, CtsRegionSeqExpr 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.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.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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.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. wgs84/doubleThe WGS84 coordinate system at double
precision. 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
occurances of more than one of the synonyms are scored as if there
are more occurance of the same term (as opposed to having a
separate term that contributes to score).weight
- A weight for this query. The default is
1.0.CtsQueryExpr elementPairGeospatialQuery(XsQNameSeqVal elementName, XsQNameSeqVal latitudeName, XsQNameSeqVal longitudeName, CtsRegionSeqExpr region, XsStringSeqVal options, XsDoubleVal 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.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.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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.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. wgs84/doubleThe WGS84 coordinate system at double
precision. 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
occurances of more than one of the synonyms are scored as if there
are more occurance of the same term (as opposed to having a
separate term that contributes to score).weight
- A weight for this query. The default is
1.0.CtsQueryExpr elementQuery(java.lang.String elementName, CtsQueryExpr 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.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.CtsQueryExpr elementQuery(XsQNameSeqVal elementName, CtsQueryExpr 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.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.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.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.value
- One or more element values to match. When
multiple values are specified, the query matches if any value
matches.CtsQueryExpr elementRangeQuery(XsQNameSeqVal elementName, XsStringVal operator, XsAnyAtomicTypeSeqVal 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.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.value
- One or more element values to match. When
multiple values are specified, the query matches if any value
matches.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.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.value
- One or more element values to match. When
multiple values are specified, the query matches if any value
matches.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).CtsQueryExpr elementRangeQuery(XsQNameSeqVal elementName, XsStringVal operator, XsAnyAtomicTypeSeqVal value, XsStringSeqVal 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.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.value
- One or more element values to match. When
multiple values are specified, the query matches if any value
matches.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).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.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.value
- One or more element values to match. When
multiple values are specified, the query matches if any value
matches.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).weight
- A weight for this query. The default is
1.0.CtsQueryExpr elementRangeQuery(XsQNameSeqVal elementName, XsStringVal operator, XsAnyAtomicTypeSeqVal value, XsStringSeqVal options, XsDoubleVal 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.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.value
- One or more element values to match. When
multiple values are specified, the query matches if any value
matches.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).weight
- A weight for this query. The default is
1.0.CtsReferenceExpr elementReference(java.lang.String element)
Provides a client interface to the cts:element-reference server function.
element
- An element QName.CtsReferenceExpr elementReference(XsQNameVal element)
Provides a client interface to the cts:element-reference server function.
element
- An element 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.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.CtsReferenceExpr elementReference(XsQNameVal element, XsStringSeqVal options)
Provides a client interface to the cts:element-reference server function.
element
- An element 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.CtsQueryExpr elementValueQuery(java.lang.String elementName)
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.CtsQueryExpr elementValueQuery(XsQNameSeqVal elementName)
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.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.text
- One or more element values to match. When
multiple strings are specified, the query matches if any string
matches.CtsQueryExpr elementValueQuery(XsQNameSeqVal elementName, XsStringSeqVal 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.text
- One or more element values to match. When
multiple strings are specified, the query matches if any string
matches.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.text
- One or more element values to match. When
multiple strings are specified, the query matches if any string
matches.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.CtsQueryExpr elementValueQuery(XsQNameSeqVal elementName, XsStringSeqVal text, XsStringSeqVal 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.text
- One or more element values to match. When
multiple strings are specified, the query matches if any string
matches.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.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.text
- One or more element values to match. When
multiple strings are specified, the query matches if any string
matches.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.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.CtsQueryExpr elementValueQuery(XsQNameSeqVal elementName, XsStringSeqVal text, XsStringSeqVal options, XsDoubleVal 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.text
- One or more element values to match. When
multiple strings are specified, the query matches if any string
matches.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.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.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.text
- Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches.CtsQueryExpr elementWordQuery(XsQNameSeqVal elementName, XsStringSeqVal 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.text
- Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches.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.text
- Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches.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.CtsQueryExpr elementWordQuery(XsQNameSeqVal elementName, XsStringSeqVal text, XsStringSeqVal 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.text
- Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches.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.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.text
- Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches.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.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.CtsQueryExpr elementWordQuery(XsQNameSeqVal elementName, XsStringSeqVal text, XsStringSeqVal options, XsDoubleVal 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.text
- Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches.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.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.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.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.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.CtsQueryExpr fieldRangeQuery(XsStringSeqVal fieldName, XsStringVal operator, XsAnyAtomicTypeSeqVal 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.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.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.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.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.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.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).CtsQueryExpr fieldRangeQuery(XsStringSeqVal fieldName, XsStringVal operator, XsAnyAtomicTypeSeqVal value, XsStringSeqVal 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.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.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.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).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.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.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.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).weight
- A weight for this query. The default is
1.0.CtsQueryExpr fieldRangeQuery(XsStringSeqVal fieldName, XsStringVal operator, XsAnyAtomicTypeSeqVal value, XsStringSeqVal options, XsDoubleVal 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.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.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.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).weight
- A weight for this query. The default is
1.0.CtsReferenceExpr fieldReference(java.lang.String field)
Provides a client interface to the cts:field-reference server function.
field
- A field name.CtsReferenceExpr fieldReference(XsStringVal field)
Provides a client interface to the cts:field-reference server function.
field
- A field name.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.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.CtsReferenceExpr fieldReference(XsStringVal field, XsStringSeqVal options)
Provides a client interface to the cts:field-reference server function.
field
- A field name.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.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).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.CtsQueryExpr fieldValueQuery(XsStringSeqVal fieldName, XsAnyAtomicTypeSeqVal 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).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.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).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.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.CtsQueryExpr fieldValueQuery(XsStringSeqVal fieldName, XsAnyAtomicTypeSeqVal text, XsStringSeqVal 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).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.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.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).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.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.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.CtsQueryExpr fieldValueQuery(XsStringSeqVal fieldName, XsAnyAtomicTypeSeqVal text, XsStringSeqVal options, XsDoubleVal 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).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.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.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.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).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).CtsQueryExpr fieldWordQuery(XsStringSeqVal fieldName, XsStringSeqVal 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).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).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).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).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.CtsQueryExpr fieldWordQuery(XsStringSeqVal fieldName, XsStringSeqVal text, XsStringSeqVal 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).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).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.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).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).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.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.CtsQueryExpr fieldWordQuery(XsStringSeqVal fieldName, XsStringSeqVal text, XsStringSeqVal options, XsDoubleVal 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).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).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.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.CtsReferenceExpr geospatialPathReference(java.lang.String pathExpression)
Provides a client interface to the cts:geospatial-path-reference server function.
pathExpression
- A path expression.CtsReferenceExpr geospatialPathReference(XsStringVal pathExpression)
Provides a client interface to the cts:geospatial-path-reference server function.
pathExpression
- A path expression.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.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. wgs84/doubleThe WGS84 coordinate system at
double precision. 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.CtsReferenceExpr geospatialPathReference(XsStringVal pathExpression, XsStringSeqVal options)
Provides a client interface to the cts:geospatial-path-reference server function.
pathExpression
- A path expression.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. wgs84/doubleThe WGS84 coordinate system at
double precision. 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.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.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. wgs84/doubleThe WGS84 coordinate system at
double precision. 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.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.CtsReferenceExpr geospatialPathReference(XsStringVal pathExpression, XsStringSeqVal options, ServerExpression map)
Provides a client interface to the cts:geospatial-path-reference server function.
pathExpression
- A path expression.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. wgs84/doubleThe WGS84 coordinate system at
double precision. 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.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.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.CtsReferenceExpr geospatialRegionPathReference(XsStringVal pathExpression)
Provides a client interface to the cts:geospatial-region-path-reference server function.
pathExpression
- The XPath expression specified in
the index configuration.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.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. wgs84/doubleThe WGS84 coordinate system at
double precision. 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.CtsReferenceExpr geospatialRegionPathReference(XsStringVal pathExpression, XsStringSeqVal options)
Provides a client interface to the cts:geospatial-region-path-reference server function.
pathExpression
- The XPath expression specified in
the index configuration.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. wgs84/doubleThe WGS84 coordinate system at
double precision. 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.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.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. wgs84/doubleThe WGS84 coordinate system at
double precision. 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.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.CtsReferenceExpr geospatialRegionPathReference(XsStringVal pathExpression, XsStringSeqVal 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.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. wgs84/doubleThe WGS84 coordinate system at
double precision. 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.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.CtsQueryExpr geospatialRegionQuery(CtsReferenceSeqExpr 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.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.region
- Criteria regions to match against the
regions specified in the $geospatial-region-reference parameter.
These regions function as the right operand of $operation.CtsQueryExpr geospatialRegionQuery(CtsReferenceSeqExpr reference, XsStringVal operation, CtsRegionSeqExpr 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.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.region
- Criteria regions to match against the
regions specified in the $geospatial-region-reference parameter.
These regions function as the right operand of $operation.CtsQueryExpr geospatialRegionQuery(CtsReferenceSeqExpr reference, java.lang.String operation, CtsRegionSeqExpr 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.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.region
- Criteria regions to match against the
regions specified in the $geospatial-region-reference parameter.
These regions function as the right operand of $operation.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
occurances of more than one of the synonyms are scored as if there
are more occurance 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.CtsQueryExpr geospatialRegionQuery(CtsReferenceSeqExpr reference, XsStringVal operation, CtsRegionSeqExpr region, XsStringSeqVal 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.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.region
- Criteria regions to match against the
regions specified in the $geospatial-region-reference parameter.
These regions function as the right operand of $operation.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
occurances of more than one of the synonyms are scored as if there
are more occurance 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.CtsQueryExpr geospatialRegionQuery(CtsReferenceSeqExpr reference, java.lang.String operation, CtsRegionSeqExpr 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.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.region
- Criteria regions to match against the
regions specified in the $geospatial-region-reference parameter.
These regions function as the right operand of $operation.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
occurances of more than one of the synonyms are scored as if there
are more occurance 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.weight
- A weight for this query. The default is
1.0.CtsQueryExpr geospatialRegionQuery(CtsReferenceSeqExpr reference, XsStringVal operation, CtsRegionSeqExpr region, XsStringSeqVal options, XsDoubleVal 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.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.region
- Criteria regions to match against the
regions specified in the $geospatial-region-reference parameter.
These regions function as the right operand of $operation.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
occurances of more than one of the synonyms are scored as if there
are more occurance 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.weight
- A weight for this query. The default is
1.0.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.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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.CtsQueryExpr jsonPropertyChildGeospatialQuery(XsStringSeqVal propertyName, XsStringSeqVal childName, CtsRegionSeqExpr 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.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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.CtsQueryExpr jsonPropertyChildGeospatialQuery(java.lang.String propertyName, java.lang.String childName, CtsRegionSeqExpr 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.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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.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. wgs84/doubleThe WGS84 coordinate system at double
precision. 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
occurances of more than one of the synonyms are scored as if there
are more occurance of the same term (as opposed to having a
separate term that contributes to score).CtsQueryExpr jsonPropertyChildGeospatialQuery(XsStringSeqVal propertyName, XsStringSeqVal childName, CtsRegionSeqExpr region, XsStringSeqVal 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.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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.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. wgs84/doubleThe WGS84 coordinate system at double
precision. 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
occurances of more than one of the synonyms are scored as if there
are more occurance of the same term (as opposed to having a
separate term that contributes to score).CtsQueryExpr jsonPropertyChildGeospatialQuery(java.lang.String propertyName, java.lang.String childName, CtsRegionSeqExpr 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.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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.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. wgs84/doubleThe WGS84 coordinate system at double
precision. 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
occurances of more than one of the synonyms are scored as if there
are more occurance of the same term (as opposed to having a
separate term that contributes to score).weight
- A weight for this query. The default is
1.0.CtsQueryExpr jsonPropertyChildGeospatialQuery(XsStringSeqVal propertyName, XsStringSeqVal childName, CtsRegionSeqExpr region, XsStringSeqVal options, XsDoubleVal 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.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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.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. wgs84/doubleThe WGS84 coordinate system at double
precision. 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
occurances of more than one of the synonyms are scored as if there
are more occurance of the same term (as opposed to having a
separate term that contributes to score).weight
- A weight for this query. The default is
1.0.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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.CtsQueryExpr jsonPropertyGeospatialQuery(XsStringSeqVal propertyName, CtsRegionSeqExpr 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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.CtsQueryExpr jsonPropertyGeospatialQuery(java.lang.String propertyName, CtsRegionSeqExpr 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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.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. wgs84/doubleThe WGS84 coordinate system at double
precision. 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
occurances of more than one of the synonyms are scored as if there
are more occurance of the same term (as opposed to having a
separate term that contributes to score).CtsQueryExpr jsonPropertyGeospatialQuery(XsStringSeqVal propertyName, CtsRegionSeqExpr region, XsStringSeqVal 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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.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. wgs84/doubleThe WGS84 coordinate system at double
precision. 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
occurances of more than one of the synonyms are scored as if there
are more occurance of the same term (as opposed to having a
separate term that contributes to score).CtsQueryExpr jsonPropertyGeospatialQuery(java.lang.String propertyName, CtsRegionSeqExpr 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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.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. wgs84/doubleThe WGS84 coordinate system at double
precision. 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
occurances of more than one of the synonyms are scored as if there
are more occurance of the same term (as opposed to having a
separate term that contributes to score).weight
- A weight for this query. The default is
1.0.CtsQueryExpr jsonPropertyGeospatialQuery(XsStringSeqVal propertyName, CtsRegionSeqExpr region, XsStringSeqVal options, XsDoubleVal 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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.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. wgs84/doubleThe WGS84 coordinate system at double
precision. 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
occurances of more than one of the synonyms are scored as if there
are more occurance of the same term (as opposed to having a
separate term that contributes to score).weight
- A weight for this query. The default is
1.0.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.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.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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.CtsQueryExpr jsonPropertyPairGeospatialQuery(XsStringSeqVal propertyName, XsStringSeqVal latitudeName, XsStringSeqVal longitudeName, CtsRegionSeqExpr 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.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.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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.CtsQueryExpr jsonPropertyPairGeospatialQuery(java.lang.String propertyName, java.lang.String latitudeName, java.lang.String longitudeName, CtsRegionSeqExpr 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.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.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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.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. wgs84/doubleThe WGS84 coordinate system at double
precision. 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
occurances of more than one of the synonyms are scored as if there
are more occurance of the same term (as opposed to having a
separate term that contributes to score).CtsQueryExpr jsonPropertyPairGeospatialQuery(XsStringSeqVal propertyName, XsStringSeqVal latitudeName, XsStringSeqVal longitudeName, CtsRegionSeqExpr region, XsStringSeqVal 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.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.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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.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. wgs84/doubleThe WGS84 coordinate system at double
precision. 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
occurances of more than one of the synonyms are scored as if there
are more occurance of the same term (as opposed to having a
separate term that contributes to score).CtsQueryExpr jsonPropertyPairGeospatialQuery(java.lang.String propertyName, java.lang.String latitudeName, java.lang.String longitudeName, CtsRegionSeqExpr 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.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.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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.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. wgs84/doubleThe WGS84 coordinate system at double
precision. 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
occurances of more than one of the synonyms are scored as if there
are more occurance of the same term (as opposed to having a
separate term that contributes to score).weight
- A weight for this query. The default is
1.0.CtsQueryExpr jsonPropertyPairGeospatialQuery(XsStringSeqVal propertyName, XsStringSeqVal latitudeName, XsStringSeqVal longitudeName, CtsRegionSeqExpr region, XsStringSeqVal options, XsDoubleVal 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.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.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.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.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. wgs84/doubleThe WGS84 coordinate system at double
precision. 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
occurances of more than one of the synonyms are scored as if there
are more occurance of the same term (as opposed to having a
separate term that contributes to score).weight
- A weight for this query. The default is
1.0.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.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.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.CtsQueryExpr jsonPropertyRangeQuery(XsStringSeqVal propertyName, XsStringVal operator, XsAnyAtomicTypeSeqVal 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.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.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.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.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.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.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).CtsQueryExpr jsonPropertyRangeQuery(XsStringSeqVal propertyName, XsStringVal operator, XsAnyAtomicTypeSeqVal value, XsStringSeqVal 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.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.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.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).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.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.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.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).weight
- A weight for this query. The default is
1.0.CtsQueryExpr jsonPropertyRangeQuery(XsStringSeqVal propertyName, XsStringVal operator, XsAnyAtomicTypeSeqVal value, XsStringSeqVal options, XsDoubleVal 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.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.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.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).weight
- A weight for this query. The default is
1.0.CtsReferenceExpr jsonPropertyReference(java.lang.String property)
Provides a client interface to the cts:json-property-reference server function.
property
- A property name.CtsReferenceExpr jsonPropertyReference(XsStringVal property)
Provides a client interface to the cts:json-property-reference server function.
property
- A property name.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.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.CtsReferenceExpr jsonPropertyReference(XsStringVal property, XsStringSeqVal options)
Provides a client interface to the cts:json-property-reference server function.
property
- A property name.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.CtsQueryExpr jsonPropertyScopeQuery(java.lang.String propertyName, CtsQueryExpr 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.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.CtsQueryExpr jsonPropertyScopeQuery(XsStringSeqVal propertyName, CtsQueryExpr 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.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.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.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.CtsQueryExpr jsonPropertyValueQuery(XsStringSeqVal propertyName, XsAnyAtomicTypeSeqVal 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.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.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.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.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.CtsQueryExpr jsonPropertyValueQuery(XsStringSeqVal propertyName, XsAnyAtomicTypeSeqVal value, XsStringSeqVal 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.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.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.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.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.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.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.CtsQueryExpr jsonPropertyValueQuery(XsStringSeqVal propertyName, XsAnyAtomicTypeSeqVal value, XsStringSeqVal options, XsDoubleVal 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.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.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.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.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.text
- Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches.CtsQueryExpr jsonPropertyWordQuery(XsStringSeqVal propertyName, XsStringSeqVal 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.text
- Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches.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.text
- Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches.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.CtsQueryExpr jsonPropertyWordQuery(XsStringSeqVal propertyName, XsStringSeqVal text, XsStringSeqVal 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.text
- Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches.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.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.text
- Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches.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.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.CtsQueryExpr jsonPropertyWordQuery(XsStringSeqVal propertyName, XsStringSeqVal text, XsStringSeqVal options, XsDoubleVal 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.text
- Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches.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.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.ServerExpression linestring(java.lang.String vertices)
Provides a client interface to the cts:linestring server function.
vertices
- The waypoints of the linestring, given
in order. vertexes. (of xs:anyAtomicType)ServerExpression linestring(ServerExpression vertices)
Provides a client interface to the cts:linestring server function.
vertices
- The waypoints of the linestring, given
in order. vertexes. (of xs:anyAtomicType)CtsQueryExpr locksFragmentQuery(CtsQueryExpr query)
Provides a client interface to the cts:locks-fragment-query server function.
query
- A query to be matched against the locks
fragment.CtsQueryExpr lsqtQuery(java.lang.String temporalCollection)
Provides a client interface to the cts:lsqt-query server function.
temporalCollection
- The name of the temporal
collection.CtsQueryExpr lsqtQuery(XsStringVal temporalCollection)
Provides a client interface to the cts:lsqt-query server function.
temporalCollection
- The name of the temporal
collection.CtsQueryExpr lsqtQuery(java.lang.String temporalCollection, java.lang.String timestamp)
Provides a client interface to the cts:lsqt-query server function.
temporalCollection
- The name of the temporal
collection.timestamp
- Return only temporal documents with a
system start time less than or equal to this value. Default is
temporal:get-lsqt($temporal-collection). Timestamps larger than
LSQT are rejected.CtsQueryExpr lsqtQuery(XsStringVal temporalCollection, XsDateTimeVal timestamp)
Provides a client interface to the cts:lsqt-query server function.
temporalCollection
- The name of the temporal
collection.timestamp
- Return only temporal documents with a
system start time less than or equal to this value. Default is
temporal:get-lsqt($temporal-collection). Timestamps larger than
LSQT are rejected.CtsQueryExpr lsqtQuery(java.lang.String temporalCollection, java.lang.String timestamp, java.lang.String... options)
Provides a client interface to the cts:lsqt-query server function.
temporalCollection
- The name of the temporal
collection.timestamp
- Return only temporal documents with a
system start time less than or equal to this value. Default is
temporal:get-lsqt($temporal-collection). Timestamps larger than
LSQT are rejected.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. "cached-incremental" Break down the query into
sub-queries and then cache each one of them for better performance.
This is enabled, by default. "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.CtsQueryExpr lsqtQuery(XsStringVal temporalCollection, XsDateTimeVal timestamp, XsStringSeqVal options)
Provides a client interface to the cts:lsqt-query server function.
temporalCollection
- The name of the temporal
collection.timestamp
- Return only temporal documents with a
system start time less than or equal to this value. Default is
temporal:get-lsqt($temporal-collection). Timestamps larger than
LSQT are rejected.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. "cached-incremental" Break down the query into
sub-queries and then cache each one of them for better performance.
This is enabled, by default. "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.CtsQueryExpr lsqtQuery(java.lang.String temporalCollection, java.lang.String timestamp, java.lang.String options, double weight)
Provides a client interface to the cts:lsqt-query server function.
temporalCollection
- The name of the temporal
collection.timestamp
- Return only temporal documents with a
system start time less than or equal to this value. Default is
temporal:get-lsqt($temporal-collection). Timestamps larger than
LSQT are rejected.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. "cached-incremental" Break down the query into
sub-queries and then cache each one of them for better performance.
This is enabled, by default. "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.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.CtsQueryExpr lsqtQuery(XsStringVal temporalCollection, XsDateTimeVal timestamp, XsStringSeqVal options, XsDoubleVal weight)
Provides a client interface to the cts:lsqt-query server function.
temporalCollection
- The name of the temporal
collection.timestamp
- Return only temporal documents with a
system start time less than or equal to this value. Default is
temporal:get-lsqt($temporal-collection). Timestamps larger than
LSQT are rejected.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. "cached-incremental" Break down the query into
sub-queries and then cache each one of them for better performance.
This is enabled, by default. "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.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.CtsQueryExpr nearQuery(CtsQueryExpr... queries)
Provides a client interface to the cts:near-query server function.
queries
- A sequence of queries to match.CtsQueryExpr nearQuery(CtsQuerySeqExpr queries)
Provides a client interface to the cts:near-query server function.
queries
- A sequence of queries to match.CtsQueryExpr nearQuery(CtsQuerySeqExpr queries, double distance)
Provides a client interface to the cts:near-query server function.
queries
- A sequence of queries to match.distance
- A distance, in number of words, between
any two matching queries. The results match if two queries match
and the distance between the two matches is equal to or less than
the specified distance. A distance of 0 matches when the text is
the exact same text or when there is overlapping text (see the
third example below). A negative distance is treated as 0. The
default value is 10.CtsQueryExpr nearQuery(CtsQuerySeqExpr queries, XsDoubleVal distance)
Provides a client interface to the cts:near-query server function.
queries
- A sequence of queries to match.distance
- A distance, in number of words, between
any two matching queries. The results match if two queries match
and the distance between the two matches is equal to or less than
the specified distance. A distance of 0 matches when the text is
the exact same text or when there is overlapping text (see the
third example below). A negative distance is treated as 0. The
default value is 10.CtsQueryExpr nearQuery(CtsQuerySeqExpr queries, double distance, java.lang.String... options)
Provides a client interface to the cts:near-query server function.
queries
- A sequence of queries to match.distance
- A distance, in number of words, between
any two matching queries. The results match if two queries match
and the distance between the two matches is equal to or less than
the specified distance. A distance of 0 matches when the text is
the exact same text or when there is overlapping text (see the
third example below). A negative distance is treated as 0. The
default value is 10.options
- Options to this query. The default value
is (). Options include: "ordered" Any near-query matches must occur
in the order of the specified sub-queries. "unordered" Any
near-query matches will satisfy the query, regardless of the order
they were specified. "minimum-distance" The minimum distance
between two matching queries. The results match if the two queries
match and the minimum distance between the two matches is greater
than or equal to the specified minimum distance. The default value
is zero. A negative distance is treated as 0.CtsQueryExpr nearQuery(CtsQuerySeqExpr queries, XsDoubleVal distance, XsStringSeqVal options)
Provides a client interface to the cts:near-query server function.
queries
- A sequence of queries to match.distance
- A distance, in number of words, between
any two matching queries. The results match if two queries match
and the distance between the two matches is equal to or less than
the specified distance. A distance of 0 matches when the text is
the exact same text or when there is overlapping text (see the
third example below). A negative distance is treated as 0. The
default value is 10.options
- Options to this query. The default value
is (). Options include: "ordered" Any near-query matches must occur
in the order of the specified sub-queries. "unordered" Any
near-query matches will satisfy the query, regardless of the order
they were specified. "minimum-distance" The minimum distance
between two matching queries. The results match if the two queries
match and the minimum distance between the two matches is greater
than or equal to the specified minimum distance. The default value
is zero. A negative distance is treated as 0.CtsQueryExpr nearQuery(CtsQuerySeqExpr queries, double distance, java.lang.String options, double weight)
Provides a client interface to the cts:near-query server function.
queries
- A sequence of queries to match.distance
- A distance, in number of words, between
any two matching queries. The results match if two queries match
and the distance between the two matches is equal to or less than
the specified distance. A distance of 0 matches when the text is
the exact same text or when there is overlapping text (see the
third example below). A negative distance is treated as 0. The
default value is 10.options
- Options to this query. The default value
is (). Options include: "ordered" Any near-query matches must occur
in the order of the specified sub-queries. "unordered" Any
near-query matches will satisfy the query, regardless of the order
they were specified. "minimum-distance" The minimum distance
between two matching queries. The results match if the two queries
match and the minimum distance between the two matches is greater
than or equal to the specified minimum distance. The default value
is zero. A negative distance is treated as 0.weight
- A weight attributed to the distance for
this query. Higher weights add to the importance of distance (as
opposed to term matches) when the relevance order is calculated.
The default value 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. This parameter has no effect if the word
positions index is not enabled.CtsQueryExpr nearQuery(CtsQuerySeqExpr queries, XsDoubleVal distance, XsStringSeqVal options, XsDoubleVal weight)
Provides a client interface to the cts:near-query server function.
queries
- A sequence of queries to match.distance
- A distance, in number of words, between
any two matching queries. The results match if two queries match
and the distance between the two matches is equal to or less than
the specified distance. A distance of 0 matches when the text is
the exact same text or when there is overlapping text (see the
third example below). A negative distance is treated as 0. The
default value is 10.options
- Options to this query. The default value
is (). Options include: "ordered" Any near-query matches must occur
in the order of the specified sub-queries. "unordered" Any
near-query matches will satisfy the query, regardless of the order
they were specified. "minimum-distance" The minimum distance
between two matching queries. The results match if the two queries
match and the minimum distance between the two matches is greater
than or equal to the specified minimum distance. The default value
is zero. A negative distance is treated as 0.weight
- A weight attributed to the distance for
this query. Higher weights add to the importance of distance (as
opposed to term matches) when the relevance order is calculated.
The default value 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. This parameter has no effect if the word
positions index is not enabled.CtsQueryExpr notInQuery(CtsQueryExpr positiveQuery, CtsQueryExpr negativeQuery)
Provides a client interface to the cts:not-in-query server function.
positiveQuery
- A positive query, specifying the
search results filtered in.negativeQuery
- A negative query, specifying the
search results to filter out.CtsQueryExpr notQuery(CtsQueryExpr query)
Provides a client interface to the cts:not-query server function.
query
- A negative query, specifying the search
results to filter out.CtsQueryExpr orQuery(CtsQueryExpr... queries)
Provides a client interface to the cts:or-query server function.
queries
- A sequence of sub-queries.CtsQueryExpr orQuery(CtsQuerySeqExpr queries)
Provides a client interface to the cts:or-query server function.
queries
- A sequence of sub-queries.CtsQueryExpr orQuery(CtsQuerySeqExpr queries, java.lang.String options)
Provides a client interface to the cts:or-query server function.
queries
- A sequence of sub-queries.options
- Options to this query. The default is
(). Options include: "synonym" Specifies that all of the terms in
the $queries 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).CtsQueryExpr orQuery(CtsQuerySeqExpr queries, XsStringSeqVal options)
Provides a client interface to the cts:or-query server function.
queries
- A sequence of sub-queries.options
- Options to this query. The default is
(). Options include: "synonym" Specifies that all of the terms in
the $queries 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).ServerExpression partOfSpeech(ServerExpression token)
Provides a client interface to the cts:part-of-speech server function.
CtsQueryExpr pathGeospatialQuery(java.lang.String pathExpression, CtsRegionExpr... region)
Provides a client interface to the cts:path-geospatial-query server function.
pathExpression
- One or more path expressions to
match. When multiple path expressions are specified, the query
matches if any path expression matches.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.CtsQueryExpr pathGeospatialQuery(XsStringSeqVal pathExpression, CtsRegionSeqExpr region)
Provides a client interface to the cts:path-geospatial-query server function.
pathExpression
- One or more path expressions to
match. When multiple path expressions are specified, the query
matches if any path expression matches.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.CtsQueryExpr pathGeospatialQuery(java.lang.String pathExpression, CtsRegionSeqExpr region, java.lang.String... options)
Provides a client interface to the cts:path-geospatial-query server function.
pathExpression
- One or more path expressions to
match. When multiple path expressions are specified, the query
matches if any path expression matches.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.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. wgs84/doubleThe WGS84 coordinate system at double
precision. 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
occurances of more than one of the synonyms are scored as if there
are more occurance of the same term (as opposed to having a
separate term that contributes to score).CtsQueryExpr pathGeospatialQuery(XsStringSeqVal pathExpression, CtsRegionSeqExpr region, XsStringSeqVal options)
Provides a client interface to the cts:path-geospatial-query server function.
pathExpression
- One or more path expressions to
match. When multiple path expressions are specified, the query
matches if any path expression matches.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.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. wgs84/doubleThe WGS84 coordinate system at double
precision. 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
occurances of more than one of the synonyms are scored as if there
are more occurance of the same term (as opposed to having a
separate term that contributes to score).CtsQueryExpr pathGeospatialQuery(java.lang.String pathExpression, CtsRegionSeqExpr region, java.lang.String options, double weight)
Provides a client interface to the cts:path-geospatial-query server function.
pathExpression
- One or more path expressions to
match. When multiple path expressions are specified, the query
matches if any path expression matches.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.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. wgs84/doubleThe WGS84 coordinate system at double
precision. 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
occurances of more than one of the synonyms are scored as if there
are more occurance of the same term (as opposed to having a
separate term that contributes to score).weight
- A weight for this query. The default is
1.0.CtsQueryExpr pathGeospatialQuery(XsStringSeqVal pathExpression, CtsRegionSeqExpr region, XsStringSeqVal options, XsDoubleVal weight)
Provides a client interface to the cts:path-geospatial-query server function.
pathExpression
- One or more path expressions to
match. When multiple path expressions are specified, the query
matches if any path expression matches.region
- One or more geographic boxes, circles,
polygons, or points. Where multiple regions are specified, the
query matches if any region matches.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. wgs84/doubleThe WGS84 coordinate system at double
precision. 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
occurances of more than one of the synonyms are scored as if there
are more occurance of the same term (as opposed to having a
separate term that contributes to score).weight
- A weight for this query. The default is
1.0.CtsQueryExpr pathRangeQuery(java.lang.String pathName, java.lang.String operator, java.lang.String value)
Provides a client interface to the cts:path-range-query server function.
pathName
- One or more XPath expressions that
identify the content to match. When multiple paths are specified,
the query matches if any path matches.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.value
- One or more values to match. These values
are compared to the value(s) addressed by the path-expression
parameter. When multiple 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.CtsQueryExpr pathRangeQuery(XsStringSeqVal pathName, XsStringVal operator, XsAnyAtomicTypeSeqVal value)
Provides a client interface to the cts:path-range-query server function.
pathName
- One or more XPath expressions that
identify the content to match. When multiple paths are specified,
the query matches if any path matches.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.value
- One or more values to match. These values
are compared to the value(s) addressed by the path-expression
parameter. When multiple 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.CtsQueryExpr pathRangeQuery(java.lang.String pathName, java.lang.String operator, java.lang.String value, java.lang.String... options)
Provides a client interface to the cts:path-range-query server function.
pathName
- One or more XPath expressions that
identify the content to match. When multiple paths are specified,
the query matches if any path matches.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.value
- One or more values to match. These values
are compared to the value(s) addressed by the path-expression
parameter. When multiple 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.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).CtsQueryExpr pathRangeQuery(XsStringSeqVal pathName, XsStringVal operator, XsAnyAtomicTypeSeqVal value, XsStringSeqVal options)
Provides a client interface to the cts:path-range-query server function.
pathName
- One or more XPath expressions that
identify the content to match. When multiple paths are specified,
the query matches if any path matches.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.value
- One or more values to match. These values
are compared to the value(s) addressed by the path-expression
parameter. When multiple 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.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).CtsQueryExpr pathRangeQuery(java.lang.String pathName, java.lang.String operator, java.lang.String value, java.lang.String options, double weight)
Provides a client interface to the cts:path-range-query server function.
pathName
- One or more XPath expressions that
identify the content to match. When multiple paths are specified,
the query matches if any path matches.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.value
- One or more values to match. These values
are compared to the value(s) addressed by the path-expression
parameter. When multiple 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.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).weight
- A weight for this query. The default is
1.0.CtsQueryExpr pathRangeQuery(XsStringSeqVal pathName, XsStringVal operator, XsAnyAtomicTypeSeqVal value, XsStringSeqVal options, XsDoubleVal weight)
Provides a client interface to the cts:path-range-query server function.
pathName
- One or more XPath expressions that
identify the content to match. When multiple paths are specified,
the query matches if any path matches.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.value
- One or more values to match. These values
are compared to the value(s) addressed by the path-expression
parameter. When multiple 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.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).weight
- A weight for this query. The default is
1.0.CtsReferenceExpr pathReference(java.lang.String pathExpression)
Provides a client interface to the cts:path-reference server function.
pathExpression
- A path range index
expression.CtsReferenceExpr pathReference(XsStringVal pathExpression)
Provides a client interface to the cts:path-reference server function.
pathExpression
- A path range index
expression.CtsReferenceExpr pathReference(java.lang.String pathExpression, java.lang.String options)
Provides a client interface to the cts:path-reference server function.
pathExpression
- A path range index
expression.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.CtsReferenceExpr pathReference(XsStringVal pathExpression, XsStringSeqVal options)
Provides a client interface to the cts:path-reference server function.
pathExpression
- A path range index
expression.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.CtsReferenceExpr pathReference(java.lang.String pathExpression, java.lang.String options, ServerExpression map)
Provides a client interface to the cts:path-reference server function.
pathExpression
- A path range index
expression.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.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.CtsReferenceExpr pathReference(XsStringVal pathExpression, XsStringSeqVal options, ServerExpression map)
Provides a client interface to the cts:path-reference server function.
pathExpression
- A path range index
expression.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.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.CtsPeriodExpr period(java.lang.String start, java.lang.String end)
Provides a client interface to the cts:period server function.
start
- The dateTime value indicating start of the
period.end
- The dateTime value indicating end of the
period.CtsPeriodExpr period(XsDateTimeVal start, XsDateTimeVal end)
Provides a client interface to the cts:period server function.
start
- The dateTime value indicating start of the
period.end
- The dateTime value indicating end of the
period.CtsQueryExpr periodCompareQuery(java.lang.String axis1, java.lang.String operator, java.lang.String axis2)
Provides a client interface to the cts:period-compare-query server function.
axis1
- Name of the first axis to compareoperator
- A comparison operator. Period is the
two timestamps contained in the axis. Operators include:
"aln_equals" Match documents whose period1 equals period2.
"aln_contains" Match documents whose period1 contains period2. i.e.
period1 starts before period2 starts and ends before period2 ends.
"aln_contained_by" Match documents whose period1 is contained by
period2. "aln_meets" Match documents whose period1 meets period2,
i.e. period1 ends at period2 start. "aln_met_by" Match documents
whose period1 meets period2, i.e. period1 starts at period2 end.
"aln_before" Match documents whose period1 is before period2, i.e.
period1 ends before period2 starts. "aln_after" Match documents
whose period1 is after period2, i.e. period1 starts after period2
ends. "aln_starts" Match documents whose period1 starts period2,
i.e. period1 starts at period2 start and ends before period2 ends.
"aln_started_by" Match documents whose period2 starts period1, i.e.
period1 starts at period2 start and ends after period2 ends.
"aln_finishes" Match documents whose period1 finishes period2, i.e.
period1 finishes at period2 finish and starts after period2 starts.
"aln_finished_by" Match documents whose period2 finishes period1,
i.e. period1 finishes at period2 finish and starts before period2
starts. "aln_overlaps" Match documents whose period1 overlaps
period2, i.e. period1 starts before period2 start and ends before
period2 ends but after period2 starts. "aln_overlapped_by" Match
documents whose period2 overlaps period1, i.e. period1 starts after
period2 start but before period2 ends and ends after period2 ends.
"iso_contains" Match documents whose period1 contains period2 in
sql 2011 standard. i.e. period1 starts before or at period2 starts
and ends after or at period2 ends. "iso_overlaps" Match documents
whose period1 overlaps period2 in sql 2011 standard. i.e. period1
and period2 have common time period. "iso_succeeds" Match documents
whose period1 succeeds period2 in sql 2011 standard. i.e. period1
starts at or after period2 ends "iso_precedes" Match documents
whose period1 precedes period2 in sql 2011 standard. i.e. period1
ends at or before period2 ends "iso_succeeds" Match documents whose
period1 succeeds period2 in sql 2011 standard. i.e. period1 starts
at or after period2 ends "iso_precedes" Match documents whose
period1 precedes period2 in sql 2011 standard. i.e. period1 ends at
or before period2 ends "iso_imm_succeeds" Match documents whose
period1 immediately succeeds period2 in sql 2011 standard. i.e.
period1 starts at period2 ends "iso_imm_precedes" Match documents
whose period1 immediately precedes period2 in sql 2011 standard.
i.e. period1 ends at period2 endsaxis2
- Name of the second period to compareCtsQueryExpr periodCompareQuery(XsStringVal axis1, XsStringVal operator, XsStringVal axis2)
Provides a client interface to the cts:period-compare-query server function.
axis1
- Name of the first axis to compareoperator
- A comparison operator. Period is the
two timestamps contained in the axis. Operators include:
"aln_equals" Match documents whose period1 equals period2.
"aln_contains" Match documents whose period1 contains period2. i.e.
period1 starts before period2 starts and ends before period2 ends.
"aln_contained_by" Match documents whose period1 is contained by
period2. "aln_meets" Match documents whose period1 meets period2,
i.e. period1 ends at period2 start. "aln_met_by" Match documents
whose period1 meets period2, i.e. period1 starts at period2 end.
"aln_before" Match documents whose period1 is before period2, i.e.
period1 ends before period2 starts. "aln_after" Match documents
whose period1 is after period2, i.e. period1 starts after period2
ends. "aln_starts" Match documents whose period1 starts period2,
i.e. period1 starts at period2 start and ends before period2 ends.
"aln_started_by" Match documents whose period2 starts period1, i.e.
period1 starts at period2 start and ends after period2 ends.
"aln_finishes" Match documents whose period1 finishes period2, i.e.
period1 finishes at period2 finish and starts after period2 starts.
"aln_finished_by" Match documents whose period2 finishes period1,
i.e. period1 finishes at period2 finish and starts before period2
starts. "aln_overlaps" Match documents whose period1 overlaps
period2, i.e. period1 starts before period2 start and ends before
period2 ends but after period2 starts. "aln_overlapped_by" Match
documents whose period2 overlaps period1, i.e. period1 starts after
period2 start but before period2 ends and ends after period2 ends.
"iso_contains" Match documents whose period1 contains period2 in
sql 2011 standard. i.e. period1 starts before or at period2 starts
and ends after or at period2 ends. "iso_overlaps" Match documents
whose period1 overlaps period2 in sql 2011 standard. i.e. period1
and period2 have common time period. "iso_succeeds" Match documents
whose period1 succeeds period2 in sql 2011 standard. i.e. period1
starts at or after period2 ends "iso_precedes" Match documents
whose period1 precedes period2 in sql 2011 standard. i.e. period1
ends at or before period2 ends "iso_succeeds" Match documents whose
period1 succeeds period2 in sql 2011 standard. i.e. period1 starts
at or after period2 ends "iso_precedes" Match documents whose
period1 precedes period2 in sql 2011 standard. i.e. period1 ends at
or before period2 ends "iso_imm_succeeds" Match documents whose
period1 immediately succeeds period2 in sql 2011 standard. i.e.
period1 starts at period2 ends "iso_imm_precedes" Match documents
whose period1 immediately precedes period2 in sql 2011 standard.
i.e. period1 ends at period2 endsaxis2
- Name of the second period to compareCtsQueryExpr periodCompareQuery(java.lang.String axis1, java.lang.String operator, java.lang.String axis2, java.lang.String options)
Provides a client interface to the cts:period-compare-query server function.
axis1
- Name of the first axis to compareoperator
- A comparison operator. Period is the
two timestamps contained in the axis. Operators include:
"aln_equals" Match documents whose period1 equals period2.
"aln_contains" Match documents whose period1 contains period2. i.e.
period1 starts before period2 starts and ends before period2 ends.
"aln_contained_by" Match documents whose period1 is contained by
period2. "aln_meets" Match documents whose period1 meets period2,
i.e. period1 ends at period2 start. "aln_met_by" Match documents
whose period1 meets period2, i.e. period1 starts at period2 end.
"aln_before" Match documents whose period1 is before period2, i.e.
period1 ends before period2 starts. "aln_after" Match documents
whose period1 is after period2, i.e. period1 starts after period2
ends. "aln_starts" Match documents whose period1 starts period2,
i.e. period1 starts at period2 start and ends before period2 ends.
"aln_started_by" Match documents whose period2 starts period1, i.e.
period1 starts at period2 start and ends after period2 ends.
"aln_finishes" Match documents whose period1 finishes period2, i.e.
period1 finishes at period2 finish and starts after period2 starts.
"aln_finished_by" Match documents whose period2 finishes period1,
i.e. period1 finishes at period2 finish and starts before period2
starts. "aln_overlaps" Match documents whose period1 overlaps
period2, i.e. period1 starts before period2 start and ends before
period2 ends but after period2 starts. "aln_overlapped_by" Match
documents whose period2 overlaps period1, i.e. period1 starts after
period2 start but before period2 ends and ends after period2 ends.
"iso_contains" Match documents whose period1 contains period2 in
sql 2011 standard. i.e. period1 starts before or at period2 starts
and ends after or at period2 ends. "iso_overlaps" Match documents
whose period1 overlaps period2 in sql 2011 standard. i.e. period1
and period2 have common time period. "iso_succeeds" Match documents
whose period1 succeeds period2 in sql 2011 standard. i.e. period1
starts at or after period2 ends "iso_precedes" Match documents
whose period1 precedes period2 in sql 2011 standard. i.e. period1
ends at or before period2 ends "iso_succeeds" Match documents whose
period1 succeeds period2 in sql 2011 standard. i.e. period1 starts
at or after period2 ends "iso_precedes" Match documents whose
period1 precedes period2 in sql 2011 standard. i.e. period1 ends at
or before period2 ends "iso_imm_succeeds" Match documents whose
period1 immediately succeeds period2 in sql 2011 standard. i.e.
period1 starts at period2 ends "iso_imm_precedes" Match documents
whose period1 immediately precedes period2 in sql 2011 standard.
i.e. period1 ends at period2 endsaxis2
- Name of the second period to compareoptions
- 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.CtsQueryExpr periodCompareQuery(XsStringVal axis1, XsStringVal operator, XsStringVal axis2, XsStringSeqVal options)
Provides a client interface to the cts:period-compare-query server function.
axis1
- Name of the first axis to compareoperator
- A comparison operator. Period is the
two timestamps contained in the axis. Operators include:
"aln_equals" Match documents whose period1 equals period2.
"aln_contains" Match documents whose period1 contains period2. i.e.
period1 starts before period2 starts and ends before period2 ends.
"aln_contained_by" Match documents whose period1 is contained by
period2. "aln_meets" Match documents whose period1 meets period2,
i.e. period1 ends at period2 start. "aln_met_by" Match documents
whose period1 meets period2, i.e. period1 starts at period2 end.
"aln_before" Match documents whose period1 is before period2, i.e.
period1 ends before period2 starts. "aln_after" Match documents
whose period1 is after period2, i.e. period1 starts after period2
ends. "aln_starts" Match documents whose period1 starts period2,
i.e. period1 starts at period2 start and ends before period2 ends.
"aln_started_by" Match documents whose period2 starts period1, i.e.
period1 starts at period2 start and ends after period2 ends.
"aln_finishes" Match documents whose period1 finishes period2, i.e.
period1 finishes at period2 finish and starts after period2 starts.
"aln_finished_by" Match documents whose period2 finishes period1,
i.e. period1 finishes at period2 finish and starts before period2
starts. "aln_overlaps" Match documents whose period1 overlaps
period2, i.e. period1 starts before period2 start and ends before
period2 ends but after period2 starts. "aln_overlapped_by" Match
documents whose period2 overlaps period1, i.e. period1 starts after
period2 start but before period2 ends and ends after period2 ends.
"iso_contains" Match documents whose period1 contains period2 in
sql 2011 standard. i.e. period1 starts before or at period2 starts
and ends after or at period2 ends. "iso_overlaps" Match documents
whose period1 overlaps period2 in sql 2011 standard. i.e. period1
and period2 have common time period. "iso_succeeds" Match documents
whose period1 succeeds period2 in sql 2011 standard. i.e. period1
starts at or after period2 ends "iso_precedes" Match documents
whose period1 precedes period2 in sql 2011 standard. i.e. period1
ends at or before period2 ends "iso_succeeds" Match documents whose
period1 succeeds period2 in sql 2011 standard. i.e. period1 starts
at or after period2 ends "iso_precedes" Match documents whose
period1 precedes period2 in sql 2011 standard. i.e. period1 ends at
or before period2 ends "iso_imm_succeeds" Match documents whose
period1 immediately succeeds period2 in sql 2011 standard. i.e.
period1 starts at period2 ends "iso_imm_precedes" Match documents
whose period1 immediately precedes period2 in sql 2011 standard.
i.e. period1 ends at period2 endsaxis2
- Name of the second period to compareoptions
- 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.CtsQueryExpr periodRangeQuery(java.lang.String axis, java.lang.String operator)
Provides a client interface to the cts:period-range-query server function.
axis
- One or more axis to match on.operator
- A comparison operator. Operators
include: "aln_equals" Match documents whose period1 equals value.
"aln_contains" Match documents whose period1 contains value. i.e.
period1 starts before value starts and ends before value ends.
"aln_contained_by" Match documents whose period1 is contained by
value. "aln_meets" Match documents whose period1 meets value, i.e.
period1 ends at value start. "aln_met_by" Match documents whose
period1 meets value, i.e. period1 starts at value end. "aln_before"
Match documents whose period1 is before value, i.e. period1 ends
before value starts. "aln_after" Match documents whose period1 is
after value, i.e. period1 starts after value ends. "aln_starts"
Match documents whose period1 starts value, i.e. period1 starts at
value start and ends before value ends. "aln_started_by" Match
documents whose value starts period1, i.e. period1 starts at value
start and ends after value ends. "aln_finishes" Match documents
whose period1 finishes value, i.e. period1 finishes at value finish
and starts after value starts. "aln_finished_by" Match documents
whose value finishes period1, i.e. period1 finishes at value finish
and starts before value starts. "aln_overlaps" Match documents
whose period1 overlaps value, i.e. period1 starts before value
start and ends before value ends but after value starts.
"aln_overlapped_by" Match documents whose value overlaps period1,
i.e. period1 starts after value start but before value ends and
ends after value ends. "iso_contains" Match documents whose period1
contains value in sql 2011 standard. i.e. period1 starts before or
at value starts and ends after or at value ends. "iso_overlaps"
Match documents whose period1 overlaps value in sql 2011 standard.
i.e. period1 and value have common time period. "iso_succeeds"
Match documents whose period1 succeeds value in sql 2011 standard.
i.e. period1 starts at or after value ends "iso_precedes" Match
documents whose period1 precedes value in sql 2011 standard. i.e.
period1 ends at or before value ends "iso_imm_succeeds" Match
documents whose period1 immediately succeeds value in sql 2011
standard. i.e. period1 starts at value end "iso_imm_precedes" Match
documents whose period1 immediately precedes value in sql 2011
standard. i.e. period1 ends at value endCtsQueryExpr periodRangeQuery(XsStringSeqVal axis, XsStringVal operator)
Provides a client interface to the cts:period-range-query server function.
axis
- One or more axis to match on.operator
- A comparison operator. Operators
include: "aln_equals" Match documents whose period1 equals value.
"aln_contains" Match documents whose period1 contains value. i.e.
period1 starts before value starts and ends before value ends.
"aln_contained_by" Match documents whose period1 is contained by
value. "aln_meets" Match documents whose period1 meets value, i.e.
period1 ends at value start. "aln_met_by" Match documents whose
period1 meets value, i.e. period1 starts at value end. "aln_before"
Match documents whose period1 is before value, i.e. period1 ends
before value starts. "aln_after" Match documents whose period1 is
after value, i.e. period1 starts after value ends. "aln_starts"
Match documents whose period1 starts value, i.e. period1 starts at
value start and ends before value ends. "aln_started_by" Match
documents whose value starts period1, i.e. period1 starts at value
start and ends after value ends. "aln_finishes" Match documents
whose period1 finishes value, i.e. period1 finishes at value finish
and starts after value starts. "aln_finished_by" Match documents
whose value finishes period1, i.e. period1 finishes at value finish
and starts before value starts. "aln_overlaps" Match documents
whose period1 overlaps value, i.e. period1 starts before value
start and ends before value ends but after value starts.
"aln_overlapped_by" Match documents whose value overlaps period1,
i.e. period1 starts after value start but before value ends and
ends after value ends. "iso_contains" Match documents whose period1
contains value in sql 2011 standard. i.e. period1 starts before or
at value starts and ends after or at value ends. "iso_overlaps"
Match documents whose period1 overlaps value in sql 2011 standard.
i.e. period1 and value have common time period. "iso_succeeds"
Match documents whose period1 succeeds value in sql 2011 standard.
i.e. period1 starts at or after value ends "iso_precedes" Match
documents whose period1 precedes value in sql 2011 standard. i.e.
period1 ends at or before value ends "iso_imm_succeeds" Match
documents whose period1 immediately succeeds value in sql 2011
standard. i.e. period1 starts at value end "iso_imm_precedes" Match
documents whose period1 immediately precedes value in sql 2011
standard. i.e. period1 ends at value endCtsQueryExpr periodRangeQuery(java.lang.String axis, java.lang.String operator, CtsPeriodExpr... period)
Provides a client interface to the cts:period-range-query server function.
axis
- One or more axis to match on.operator
- A comparison operator. Operators
include: "aln_equals" Match documents whose period1 equals value.
"aln_contains" Match documents whose period1 contains value. i.e.
period1 starts before value starts and ends before value ends.
"aln_contained_by" Match documents whose period1 is contained by
value. "aln_meets" Match documents whose period1 meets value, i.e.
period1 ends at value start. "aln_met_by" Match documents whose
period1 meets value, i.e. period1 starts at value end. "aln_before"
Match documents whose period1 is before value, i.e. period1 ends
before value starts. "aln_after" Match documents whose period1 is
after value, i.e. period1 starts after value ends. "aln_starts"
Match documents whose period1 starts value, i.e. period1 starts at
value start and ends before value ends. "aln_started_by" Match
documents whose value starts period1, i.e. period1 starts at value
start and ends after value ends. "aln_finishes" Match documents
whose period1 finishes value, i.e. period1 finishes at value finish
and starts after value starts. "aln_finished_by" Match documents
whose value finishes period1, i.e. period1 finishes at value finish
and starts before value starts. "aln_overlaps" Match documents
whose period1 overlaps value, i.e. period1 starts before value
start and ends before value ends but after value starts.
"aln_overlapped_by" Match documents whose value overlaps period1,
i.e. period1 starts after value start but before value ends and
ends after value ends. "iso_contains" Match documents whose period1
contains value in sql 2011 standard. i.e. period1 starts before or
at value starts and ends after or at value ends. "iso_overlaps"
Match documents whose period1 overlaps value in sql 2011 standard.
i.e. period1 and value have common time period. "iso_succeeds"
Match documents whose period1 succeeds value in sql 2011 standard.
i.e. period1 starts at or after value ends "iso_precedes" Match
documents whose period1 precedes value in sql 2011 standard. i.e.
period1 ends at or before value ends "iso_imm_succeeds" Match
documents whose period1 immediately succeeds value in sql 2011
standard. i.e. period1 starts at value end "iso_imm_precedes" Match
documents whose period1 immediately precedes value in sql 2011
standard. i.e. period1 ends at value endperiod
- the cts:period to perform operations on.
When multiple values are specified, the query matches if any value
matches.CtsQueryExpr periodRangeQuery(XsStringSeqVal axis, XsStringVal operator, CtsPeriodSeqExpr period)
Provides a client interface to the cts:period-range-query server function.
axis
- One or more axis to match on.operator
- A comparison operator. Operators
include: "aln_equals" Match documents whose period1 equals value.
"aln_contains" Match documents whose period1 contains value. i.e.
period1 starts before value starts and ends before value ends.
"aln_contained_by" Match documents whose period1 is contained by
value. "aln_meets" Match documents whose period1 meets value, i.e.
period1 ends at value start. "aln_met_by" Match documents whose
period1 meets value, i.e. period1 starts at value end. "aln_before"
Match documents whose period1 is before value, i.e. period1 ends
before value starts. "aln_after" Match documents whose period1 is
after value, i.e. period1 starts after value ends. "aln_starts"
Match documents whose period1 starts value, i.e. period1 starts at
value start and ends before value ends. "aln_started_by" Match
documents whose value starts period1, i.e. period1 starts at value
start and ends after value ends. "aln_finishes" Match documents
whose period1 finishes value, i.e. period1 finishes at value finish
and starts after value starts. "aln_finished_by" Match documents
whose value finishes period1, i.e. period1 finishes at value finish
and starts before value starts. "aln_overlaps" Match documents
whose period1 overlaps value, i.e. period1 starts before value
start and ends before value ends but after value starts.
"aln_overlapped_by" Match documents whose value overlaps period1,
i.e. period1 starts after value start but before value ends and
ends after value ends. "iso_contains" Match documents whose period1
contains value in sql 2011 standard. i.e. period1 starts before or
at value starts and ends after or at value ends. "iso_overlaps"
Match documents whose period1 overlaps value in sql 2011 standard.
i.e. period1 and value have common time period. "iso_succeeds"
Match documents whose period1 succeeds value in sql 2011 standard.
i.e. period1 starts at or after value ends "iso_precedes" Match
documents whose period1 precedes value in sql 2011 standard. i.e.
period1 ends at or before value ends "iso_imm_succeeds" Match
documents whose period1 immediately succeeds value in sql 2011
standard. i.e. period1 starts at value end "iso_imm_precedes" Match
documents whose period1 immediately precedes value in sql 2011
standard. i.e. period1 ends at value endperiod
- the cts:period to perform operations on.
When multiple values are specified, the query matches if any value
matches.CtsQueryExpr periodRangeQuery(java.lang.String axis, java.lang.String operator, CtsPeriodSeqExpr period, java.lang.String options)
Provides a client interface to the cts:period-range-query server function.
axis
- One or more axis to match on.operator
- A comparison operator. Operators
include: "aln_equals" Match documents whose period1 equals value.
"aln_contains" Match documents whose period1 contains value. i.e.
period1 starts before value starts and ends before value ends.
"aln_contained_by" Match documents whose period1 is contained by
value. "aln_meets" Match documents whose period1 meets value, i.e.
period1 ends at value start. "aln_met_by" Match documents whose
period1 meets value, i.e. period1 starts at value end. "aln_before"
Match documents whose period1 is before value, i.e. period1 ends
before value starts. "aln_after" Match documents whose period1 is
after value, i.e. period1 starts after value ends. "aln_starts"
Match documents whose period1 starts value, i.e. period1 starts at
value start and ends before value ends. "aln_started_by" Match
documents whose value starts period1, i.e. period1 starts at value
start and ends after value ends. "aln_finishes" Match documents
whose period1 finishes value, i.e. period1 finishes at value finish
and starts after value starts. "aln_finished_by" Match documents
whose value finishes period1, i.e. period1 finishes at value finish
and starts before value starts. "aln_overlaps" Match documents
whose period1 overlaps value, i.e. period1 starts before value
start and ends before value ends but after value starts.
"aln_overlapped_by" Match documents whose value overlaps period1,
i.e. period1 starts after value start but before value ends and
ends after value ends. "iso_contains" Match documents whose period1
contains value in sql 2011 standard. i.e. period1 starts before or
at value starts and ends after or at value ends. "iso_overlaps"
Match documents whose period1 overlaps value in sql 2011 standard.
i.e. period1 and value have common time period. "iso_succeeds"
Match documents whose period1 succeeds value in sql 2011 standard.
i.e. period1 starts at or after value ends "iso_precedes" Match
documents whose period1 precedes value in sql 2011 standard. i.e.
period1 ends at or before value ends "iso_imm_succeeds" Match
documents whose period1 immediately succeeds value in sql 2011
standard. i.e. period1 starts at value end "iso_imm_precedes" Match
documents whose period1 immediately precedes value in sql 2011
standard. i.e. period1 ends at value endperiod
- the cts:period to perform operations on.
When multiple values are specified, the query matches if any value
matches.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. "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.CtsQueryExpr periodRangeQuery(XsStringSeqVal axis, XsStringVal operator, CtsPeriodSeqExpr period, XsStringSeqVal options)
Provides a client interface to the cts:period-range-query server function.
axis
- One or more axis to match on.operator
- A comparison operator. Operators
include: "aln_equals" Match documents whose period1 equals value.
"aln_contains" Match documents whose period1 contains value. i.e.
period1 starts before value starts and ends before value ends.
"aln_contained_by" Match documents whose period1 is contained by
value. "aln_meets" Match documents whose period1 meets value, i.e.
period1 ends at value start. "aln_met_by" Match documents whose
period1 meets value, i.e. period1 starts at value end. "aln_before"
Match documents whose period1 is before value, i.e. period1 ends
before value starts. "aln_after" Match documents whose period1 is
after value, i.e. period1 starts after value ends. "aln_starts"
Match documents whose period1 starts value, i.e. period1 starts at
value start and ends before value ends. "aln_started_by" Match
documents whose value starts period1, i.e. period1 starts at value
start and ends after value ends. "aln_finishes" Match documents
whose period1 finishes value, i.e. period1 finishes at value finish
and starts after value starts. "aln_finished_by" Match documents
whose value finishes period1, i.e. period1 finishes at value finish
and starts before value starts. "aln_overlaps" Match documents
whose period1 overlaps value, i.e. period1 starts before value
start and ends before value ends but after value starts.
"aln_overlapped_by" Match documents whose value overlaps period1,
i.e. period1 starts after value start but before value ends and
ends after value ends. "iso_contains" Match documents whose period1
contains value in sql 2011 standard. i.e. period1 starts before or
at value starts and ends after or at value ends. "iso_overlaps"
Match documents whose period1 overlaps value in sql 2011 standard.
i.e. period1 and value have common time period. "iso_succeeds"
Match documents whose period1 succeeds value in sql 2011 standard.
i.e. period1 starts at or after value ends "iso_precedes" Match
documents whose period1 precedes value in sql 2011 standard. i.e.
period1 ends at or before value ends "iso_imm_succeeds" Match
documents whose period1 immediately succeeds value in sql 2011
standard. i.e. period1 starts at value end "iso_imm_precedes" Match
documents whose period1 immediately precedes value in sql 2011
standard. i.e. period1 ends at value endperiod
- the cts:period to perform operations on.
When multiple values are specified, the query matches if any value
matches.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. "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.ServerExpression point(double latitude, double longitude)
Provides a client interface to the cts:point server function.
ServerExpression point(ServerExpression latitude, ServerExpression longitude)
Provides a client interface to the cts:point server function.
ServerExpression pointLatitude(ServerExpression point)
Provides a client interface to the cts:point-latitude server function.
point
- The point. (of cts:point)ServerExpression pointLongitude(ServerExpression point)
Provides a client interface to the cts:point-longitude server function.
point
- The point. (of cts:point)ServerExpression polygon(ServerExpression vertices)
Provides a client interface to the cts:polygon server function.
vertices
- The vertices of the polygon, given in
order. No edge may cover more than 180 degrees of either latitude
or longitude. The polygon as a whole may not encompass both poles.
These constraints are necessary to ensure an unambiguous
interpretation of the polygon. There must be at least three
vertices. The first vertex should be identical to the last vertex
to close the polygon. vertexes. (of xs:anyAtomicType)CtsQueryExpr propertiesFragmentQuery(CtsQueryExpr query)
Provides a client interface to the cts:properties-fragment-query server function.
query
- A query to be matched against the
properties fragment.CtsQueryExpr rangeQuery(CtsReferenceSeqExpr index, java.lang.String operator, java.lang.String value)
Provides a client interface to the cts:range-query server function.
index
- One or more range index references. When
multiple indexes are specified, the query matches if any index
matches.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.value
- One or more values to match. When multiple
values are specified, the query matches if any value matches.CtsQueryExpr rangeQuery(CtsReferenceSeqExpr index, XsStringVal operator, XsAnyAtomicTypeSeqVal value)
Provides a client interface to the cts:range-query server function.
index
- One or more range index references. When
multiple indexes are specified, the query matches if any index
matches.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.value
- One or more values to match. When multiple
values are specified, the query matches if any value matches.CtsQueryExpr rangeQuery(CtsReferenceSeqExpr index, java.lang.String operator, java.lang.String value, java.lang.String... options)
Provides a client interface to the cts:range-query server function.
index
- One or more range index references. When
multiple indexes are specified, the query matches if any index
matches.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.value
- One or more values to match. When multiple
values are specified, the query matches if any value matches.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. "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).CtsQueryExpr rangeQuery(CtsReferenceSeqExpr index, XsStringVal operator, XsAnyAtomicTypeSeqVal value, XsStringSeqVal options)
Provides a client interface to the cts:range-query server function.
index
- One or more range index references. When
multiple indexes are specified, the query matches if any index
matches.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.value
- One or more values to match. When multiple
values are specified, the query matches if any value matches.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. "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).CtsQueryExpr rangeQuery(CtsReferenceSeqExpr index, java.lang.String operator, java.lang.String value, java.lang.String options, double weight)
Provides a client interface to the cts:range-query server function.
index
- One or more range index references. When
multiple indexes are specified, the query matches if any index
matches.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.value
- One or more values to match. When multiple
values are specified, the query matches if any value matches.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. "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).weight
- A weight for this query. The default is
1.0.CtsQueryExpr rangeQuery(CtsReferenceSeqExpr index, XsStringVal operator, XsAnyAtomicTypeSeqVal value, XsStringSeqVal options, XsDoubleVal weight)
Provides a client interface to the cts:range-query server function.
index
- One or more range index references. When
multiple indexes are specified, the query matches if any index
matches.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.value
- One or more values to match. When multiple
values are specified, the query matches if any value matches.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. "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).weight
- A weight for this query. The default is
1.0.ServerExpression stem(ServerExpression text)
Provides a client interface to the cts:stem server function.
ServerExpression stem(ServerExpression text, java.lang.String language)
Provides a client interface to the cts:stem server function.
ServerExpression stem(ServerExpression text, ServerExpression language)
Provides a client interface to the cts:stem server function.
ServerExpression stem(ServerExpression text, java.lang.String language, java.lang.String partOfSpeech)
Provides a client interface to the cts:stem server function.
text
- A word or phrase to stem. (of xs:string)language
- A language to use for stemming. If not
supplied, it uses the database default language. (of xs:string)partOfSpeech
- A part of speech to use for
stemming. The default is the unspecified part of speech. This
parameter is for testing custom stemmers. (of xs:string)ServerExpression stem(ServerExpression text, ServerExpression language, ServerExpression partOfSpeech)
Provides a client interface to the cts:stem server function.
text
- A word or phrase to stem. (of xs:string)language
- A language to use for stemming. If not
supplied, it uses the database default language. (of xs:string)partOfSpeech
- A part of speech to use for
stemming. The default is the unspecified part of speech. This
parameter is for testing custom stemmers. (of xs:string)ServerExpression tokenize(ServerExpression text)
Provides a client interface to the cts:tokenize server function.
ServerExpression tokenize(ServerExpression text, java.lang.String language)
Provides a client interface to the cts:tokenize server function.
ServerExpression tokenize(ServerExpression text, ServerExpression language)
Provides a client interface to the cts:tokenize server function.
ServerExpression tokenize(ServerExpression text, java.lang.String language, java.lang.String field)
Provides a client interface to the cts:tokenize server function.
text
- A word or phrase to tokenize. (of xs:string)language
- A language to use for tokenization. If
not supplied, it uses the database default language. (of xs:string)field
- A field to use for tokenization. If the
field has custom tokenization rules, they will be used. If no field
is supplied or the field has no custom tokenization rules, the
default tokenization rules are used. (of xs:string)ServerExpression tokenize(ServerExpression text, ServerExpression language, ServerExpression field)
Provides a client interface to the cts:tokenize server function.
text
- A word or phrase to tokenize. (of xs:string)language
- A language to use for tokenization. If
not supplied, it uses the database default language. (of xs:string)field
- A field to use for tokenization. If the
field has custom tokenization rules, they will be used. If no field
is supplied or the field has no custom tokenization rules, the
default tokenization rules are used. (of xs:string)CtsQueryExpr tripleRangeQuery(java.lang.String subject, java.lang.String predicate, java.lang.String object)
Provides a client interface to the cts:triple-range-query server function.
subject
- The subjects to look up. When multiple
values are specified, the query matches if any value matches. When
the empty sequence is specified, then triples with any subject are
matched.predicate
- The predicates to look up. When
multiple values are specified, the query matches if any value
matches. When the empty sequence is specified, then triples with
any predicate are matched.object
- The objects to look up. When multiple
values are specified, the query matches if any value matches. When
the empty sequence is specified, then triples with any object are
matched.CtsQueryExpr tripleRangeQuery(XsAnyAtomicTypeSeqVal subject, XsAnyAtomicTypeSeqVal predicate, XsAnyAtomicTypeSeqVal object)
Provides a client interface to the cts:triple-range-query server function.
subject
- The subjects to look up. When multiple
values are specified, the query matches if any value matches. When
the empty sequence is specified, then triples with any subject are
matched.predicate
- The predicates to look up. When
multiple values are specified, the query matches if any value
matches. When the empty sequence is specified, then triples with
any predicate are matched.object
- The objects to look up. When multiple
values are specified, the query matches if any value matches. When
the empty sequence is specified, then triples with any object are
matched.CtsQueryExpr tripleRangeQuery(java.lang.String subject, java.lang.String predicate, java.lang.String object, java.lang.String operator)
Provides a client interface to the cts:triple-range-query server function.
subject
- The subjects to look up. When multiple
values are specified, the query matches if any value matches. When
the empty sequence is specified, then triples with any subject are
matched.predicate
- The predicates to look up. When
multiple values are specified, the query matches if any value
matches. When the empty sequence is specified, then triples with
any predicate are matched.object
- The objects to look up. When multiple
values are specified, the query matches if any value matches. When
the empty sequence is specified, then triples with any object are
matched.operator
- If a single string is provided it is
treated as the operator for the $object values. If a sequence of
three strings are provided, they give the operators for $subject,
$predicate and $object in turn. The default operator is "=".
Operators include: "sameTerm" Match triple index values which are
the same RDF term as $value. This compares aspects of values that
are ignored in XML Schema comparison semantics, like timezone and
derived type of $value. "<" 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.CtsQueryExpr tripleRangeQuery(XsAnyAtomicTypeSeqVal subject, XsAnyAtomicTypeSeqVal predicate, XsAnyAtomicTypeSeqVal object, XsStringSeqVal operator)
Provides a client interface to the cts:triple-range-query server function.
subject
- The subjects to look up. When multiple
values are specified, the query matches if any value matches. When
the empty sequence is specified, then triples with any subject are
matched.predicate
- The predicates to look up. When
multiple values are specified, the query matches if any value
matches. When the empty sequence is specified, then triples with
any predicate are matched.object
- The objects to look up. When multiple
values are specified, the query matches if any value matches. When
the empty sequence is specified, then triples with any object are
matched.operator
- If a single string is provided it is
treated as the operator for the $object values. If a sequence of
three strings are provided, they give the operators for $subject,
$predicate and $object in turn. The default operator is "=".
Operators include: "sameTerm" Match triple index values which are
the same RDF term as $value. This compares aspects of values that
are ignored in XML Schema comparison semantics, like timezone and
derived type of $value. "<" 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.CtsQueryExpr tripleRangeQuery(java.lang.String subject, java.lang.String predicate, java.lang.String object, java.lang.String operator, java.lang.String... options)
Provides a client interface to the cts:triple-range-query server function.
subject
- The subjects to look up. When multiple
values are specified, the query matches if any value matches. When
the empty sequence is specified, then triples with any subject are
matched.predicate
- The predicates to look up. When
multiple values are specified, the query matches if any value
matches. When the empty sequence is specified, then triples with
any predicate are matched.object
- The objects to look up. When multiple
values are specified, the query matches if any value matches. When
the empty sequence is specified, then triples with any object are
matched.operator
- If a single string is provided it is
treated as the operator for the $object values. If a sequence of
three strings are provided, they give the operators for $subject,
$predicate and $object in turn. The default operator is "=".
Operators include: "sameTerm" Match triple index values which are
the same RDF term as $value. This compares aspects of values that
are ignored in XML Schema comparison semantics, like timezone and
derived type of $value. "<" 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.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.CtsQueryExpr tripleRangeQuery(XsAnyAtomicTypeSeqVal subject, XsAnyAtomicTypeSeqVal predicate, XsAnyAtomicTypeSeqVal object, XsStringSeqVal operator, XsStringSeqVal options)
Provides a client interface to the cts:triple-range-query server function.
subject
- The subjects to look up. When multiple
values are specified, the query matches if any value matches. When
the empty sequence is specified, then triples with any subject are
matched.predicate
- The predicates to look up. When
multiple values are specified, the query matches if any value
matches. When the empty sequence is specified, then triples with
any predicate are matched.object
- The objects to look up. When multiple
values are specified, the query matches if any value matches. When
the empty sequence is specified, then triples with any object are
matched.operator
- If a single string is provided it is
treated as the operator for the $object values. If a sequence of
three strings are provided, they give the operators for $subject,
$predicate and $object in turn. The default operator is "=".
Operators include: "sameTerm" Match triple index values which are
the same RDF term as $value. This compares aspects of values that
are ignored in XML Schema comparison semantics, like timezone and
derived type of $value. "<" 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.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.CtsQueryExpr tripleRangeQuery(java.lang.String subject, java.lang.String predicate, java.lang.String object, java.lang.String operator, java.lang.String options, double weight)
Provides a client interface to the cts:triple-range-query server function.
subject
- The subjects to look up. When multiple
values are specified, the query matches if any value matches. When
the empty sequence is specified, then triples with any subject are
matched.predicate
- The predicates to look up. When
multiple values are specified, the query matches if any value
matches. When the empty sequence is specified, then triples with
any predicate are matched.object
- The objects to look up. When multiple
values are specified, the query matches if any value matches. When
the empty sequence is specified, then triples with any object are
matched.operator
- If a single string is provided it is
treated as the operator for the $object values. If a sequence of
three strings are provided, they give the operators for $subject,
$predicate and $object in turn. The default operator is "=".
Operators include: "sameTerm" Match triple index values which are
the same RDF term as $value. This compares aspects of values that
are ignored in XML Schema comparison semantics, like timezone and
derived type of $value. "<" 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.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.weight
- A weight for this query. The default is
1.0.CtsQueryExpr tripleRangeQuery(XsAnyAtomicTypeSeqVal subject, XsAnyAtomicTypeSeqVal predicate, XsAnyAtomicTypeSeqVal object, XsStringSeqVal operator, XsStringSeqVal options, XsDoubleVal weight)
Provides a client interface to the cts:triple-range-query server function.
subject
- The subjects to look up. When multiple
values are specified, the query matches if any value matches. When
the empty sequence is specified, then triples with any subject are
matched.predicate
- The predicates to look up. When
multiple values are specified, the query matches if any value
matches. When the empty sequence is specified, then triples with
any predicate are matched.object
- The objects to look up. When multiple
values are specified, the query matches if any value matches. When
the empty sequence is specified, then triples with any object are
matched.operator
- If a single string is provided it is
treated as the operator for the $object values. If a sequence of
three strings are provided, they give the operators for $subject,
$predicate and $object in turn. The default operator is "=".
Operators include: "sameTerm" Match triple index values which are
the same RDF term as $value. This compares aspects of values that
are ignored in XML Schema comparison semantics, like timezone and
derived type of $value. "<" 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.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.weight
- A weight for this query. The default is
1.0.CtsQueryExpr trueQuery()
Provides a client interface to the cts:true-query server function.
CtsReferenceExpr uriReference()
Provides a client interface to the cts:uri-reference server function.
CtsQueryExpr wordQuery(java.lang.String text)
Provides a client interface to the cts:word-query server function.
text
- Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches.CtsQueryExpr wordQuery(XsStringSeqVal text)
Provides a client interface to the cts:word-query server function.
text
- Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches.CtsQueryExpr wordQuery(java.lang.String text, java.lang.String... options)
Provides a client interface to the cts:word-query server function.
text
- Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches.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.CtsQueryExpr wordQuery(XsStringSeqVal text, XsStringSeqVal options)
Provides a client interface to the cts:word-query server function.
text
- Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches.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.CtsQueryExpr wordQuery(java.lang.String text, java.lang.String options, double weight)
Provides a client interface to the cts:word-query server function.
text
- Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches.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.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.CtsQueryExpr wordQuery(XsStringSeqVal text, XsStringSeqVal options, XsDoubleVal weight)
Provides a client interface to the cts:word-query server function.
text
- Some words or phrases to match. When
multiple strings are specified, the query matches if any string
matches.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.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.CtsPeriodSeqExpr periodSeq(CtsPeriodExpr... items)
items
- the CtsPeriodExpr items collected by the
sequenceCtsQuerySeqExpr querySeq(CtsQueryExpr... items)
items
- the CtsQueryExpr items collected by the
sequenceCtsReferenceSeqExpr referenceSeq(CtsReferenceExpr... items)
items
- the CtsReferenceExpr items collected by
the sequenceCtsRegionSeqExpr regionSeq(CtsRegionExpr... items)
items
- the CtsRegionExpr items collected by the
sequenceCopyright © 2013-2019 MarkLogic Corporation.