com.marklogic.mapreduce.functions.PathReference Maven / Gradle / Ivy
/*
* Copyright (c) 2021 MarkLogic Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.marklogic.mapreduce.functions;
/**
* Wrapper class for the cts:path-reference function.
* This class represents a reference to a path value lexicon
* (path range index).
*
* @author jchen
*/
public abstract class PathReference extends Reference {
public void append(StringBuilder buf) {
buf.append("cts:path-reference(\"");
buf.append(getPathExpression());
buf.append("\"");
String[] userOptions = getUserDefinedOptions();
if (userOptions != null) {
buf.append(",");
for (String userOption : userOptions) {
buf.append(",\"").append(userOption).append("\"");
}
}
buf.append(")");
}
/**
* Get the path range expression represented by this lexicon.
*
* This path expression must correspond to the path expression
* used to create an existing path range index.
*
* @return A path range expression.
*/
public abstract String getPathExpression();
/**
* Get user-defined options for the path reference.
*
* This method corresponds to the $options parameter of the path
* reference function. Override this method to pass options to the path
* reference function. For a list of available options, see
* cts:path-reference in the XQuery and XSLT Reference.
*
*/
public String[] getUserDefinedOptions() {
return null;
}
}