com.marklogic.mapreduce.functions.LexiconFunction Maven / Gradle / Ivy
/*
* Copyright 2003-2019 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;
import java.util.Collection;
/**
* Super class for all supported lexicon functions.
* {@link com.marklogic.mapreduce.MarkLogicInputFormat} and
* {@link com.marklogic.mapreduce.MarkLogicRecordReader} get the input query and
* split query from these classes when a lexicon function is specified in the
* config by setting
* {@link com.marklogic.mapreduce.MarkLogicConstants#INPUT_LEXICON_FUNCTION_CLASS
* input.lexiconfunctionclass}.
*
* @author jchen
*/
public abstract class LexiconFunction {
/**
* Get the cts:query specified by the user as part of the lexicon function
* to filter fragments used to retrieve the lexicons.
*
* This corresponds to the $query parameter of a lexicon function. Users
* may override this method if the default is not suitable.
*
*
* @return cts:query.
*/
public String getLexiconQuery() {
return "cts:and-query(())";
}
/**
* Get the input query used by a record reader. Users must not override
* this method.
* @param nsCol alias-URI pairs of namespace specs
* @param start start of the split
* @param count count of the split
*
* @return input query.
*/
public abstract String getInputQuery(Collection nsCol,
long start, long count);
/**
* Get user-defined options for the lexicon function.
*
* This method corresponds to the $options parameter of a lexicon function.
* Override this method to pass options to the lexicon function. The
* options skip and truncate are reserved for internal
* use by the connector.
*
*/
public String[] getUserDefinedOptions() {
return null;
}
}