com.sas.cas.actions.search

Class SearchIndexOptions

java.lang.Object

com.sas.cas.CASActionOptions

com.sas.cas.CASGeneratedActionOptions

com.sas.cas.actions.search.SearchIndexOptions

All Implemented Interfaces:

KeyedMap<java.lang.String,java.lang.Object>, java.io.Serializable, java.util.Map<java.lang.String,java.lang.Object>

public class SearchIndexOptions
extends CASGeneratedActionOptions

Options for searchIndex: Searches for a query against an index and retrieves records, documents, and tuples that are relevant to that query.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.sas.cas.CASActionOptions

CASActionOptions.EnumValue, CASActionOptions.FORMAT

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION_NAME
static java.lang.String	ACTION_SET_NAME
static java.lang.String	KEY_AUTHURI
static java.lang.String	KEY_CASOUT
static java.lang.String	KEY_IDVARNAME
static java.lang.String	KEY_INDEX
static java.lang.String	KEY_JSON
static java.lang.String	KEY_JSONOUT
static java.lang.String	KEY_OUTPUT
static java.lang.String	KEY_QUERY
static java.lang.String	KEY_RELVARNAME
static java.lang.String	KEY_SORTLOCALE

Fields inherited from class com.sas.cas.CASActionOptions

FLAGS_EXPAND_ARRAYS, FLAGS_IGNORE_DISPOSITION_ERROR, FLAGS_RETURN_RESULTS_ON_EXCEPTION, FLAGS_SKIP_ACTION_EVENTS, FLAGS_SKIP_RESULTS, HIDDEN_PASSWORD, JSON_NULL, LUA_NIL, PARAMETER_FLAG_ISPASSWORD, PARAMETER_FLAG_ISPATH, PARAMETER_FLAG_ISTABLENAME, PARAMETER_FLAG_ISVAR, PARAMETER_FLAG_REQUIRED, PYTHON_NULL, SERIALIZED_PREFIX

Constructor Summary

Constructors

Constructor and Description
SearchIndexOptions()
SearchIndexOptions(CASActionOptions options)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAuthUri()
Casouttable	getCasOut()
java.lang.String	getIdVarName()
Castable	getIndex()
java.lang.String	getJson()
java.lang.Boolean	getJsonOut()
java.lang.String	getOutput()
java.lang.String	getQuery()
java.lang.String	getRelVarName()
java.lang.Object	getServerDefaultValue(java.lang.String key) Gets the server default value, if known.
java.lang.String	getSortLocale()
SearchIndexOptions	setAuthUri(java.lang.String value) Sets the value of parameter 'authUri': specifies the authorization URI for search.
SearchIndexOptions	setCasOut(Casouttable value) Sets the value of parameter 'casOut': specifies the name of the raw output table.
SearchIndexOptions	setIdVarName(java.lang.String value) Sets the value of parameter 'idVarName': User-defined ID name.
SearchIndexOptions	setIndex(Castable value) Sets the value of parameter 'index': specifies the name of the input index table.
SearchIndexOptions	setJson(java.lang.String value) Sets the value of parameter 'json': specifies the JSON input that guides the search action, such as simplequery and rangefilter.
SearchIndexOptions	setJsonOut(java.lang.Boolean value) Sets the value of parameter 'jsonOut': requests a json output of the results.
SearchIndexOptions	setOutput(java.lang.String value) Sets the value of parameter 'output': specifies the output specification in json form.
SearchIndexOptions	setQuery(java.lang.String value) Sets the value of parameter 'query': specifies the input query in json form.
SearchIndexOptions	setRelVarName(java.lang.String value) Sets the value of parameter 'relVarName': User-defined relevance name.
SearchIndexOptions	setSortLocale(java.lang.String value) Sets the value of parameter 'sortLocale': specifies locale to use for comparisons during sort.

Methods inherited from class com.sas.cas.CASActionOptions

addActionFlags, addParameterFlag, appendValue, checkForPasswords, clear, containsKey, containsValue, convertToEnumArray, copy, deserialize, entrySet, equals, findOptionsClass, findSetter, get, getActionFlags, getActionName, getActionResponseEventListener, getActionResultEventListener, getActionSetName, getCASClient, getClassName, getDebugOptions, getDispositionEventListener, getFullyQualifiedActionName, getLogEventListener, getLogMessage, getMessageOutputStream, getMessageTagHandler, getParameter, getParameterAsBoolean, getParameterAsByteArray, getParameterAsDouble, getParameterAsDoubleArray, getParameterAsInteger, getParameterAsIntegerArray, getParameterAsLong, getParameterAsLongArray, getParameterAsString, getParameterAsStringArray, getParameterFlags, getParameterIgnoreCase, getParameterIgnoreCase, getParameterKeys, getPerformanceEventListener, getPropertyKey, getSessionID, getUserProperty, getUserPropertyKeys, hashCode, invoke, isEmpty, isFlagSet, isMap, isParameterFlagSet, isPassword, isPath, isRequired, isTable, isVariable, keySet, put, putAll, putAllDeep, putDeep, putDeep, quoteIfNotNull, remove, removeParameter, set, setActionFlags, setActionName, setActionResponseEventListener, setActionResultEventListener, setActionSetName, setCASClient, setDebugOptions, setDispositionEventListener, setFullyQualifiedActionName, setLogEventListener, setLogMessage, setMessageOutputStream, setMessageTagHandler, setParameter, setPerformanceEventListener, setPropertyKey, setSessionID, setUserProperty, size, toCASLString, toLuaString, toLuaString, toOptionsWithGeneratedClasses, toSerialized, toString, toString, toString, upcaseFirstChar, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

ACTION_SET_NAME

public static final java.lang.String ACTION_SET_NAME

See Also:

Constant Field Values

ACTION_NAME

public static final java.lang.String ACTION_NAME

See Also:

Constant Field Values

KEY_INDEX

public static final java.lang.String KEY_INDEX

See Also:

Constant Field Values

KEY_JSON

public static final java.lang.String KEY_JSON

See Also:

Constant Field Values

KEY_QUERY

public static final java.lang.String KEY_QUERY

See Also:

Constant Field Values

KEY_OUTPUT

public static final java.lang.String KEY_OUTPUT

See Also:

Constant Field Values

KEY_AUTHURI

public static final java.lang.String KEY_AUTHURI

See Also:

Constant Field Values

KEY_IDVARNAME

public static final java.lang.String KEY_IDVARNAME

See Also:

Constant Field Values

KEY_RELVARNAME

public static final java.lang.String KEY_RELVARNAME

See Also:

Constant Field Values

KEY_SORTLOCALE

public static final java.lang.String KEY_SORTLOCALE

See Also:

Constant Field Values

KEY_JSONOUT

public static final java.lang.String KEY_JSONOUT

See Also:

Constant Field Values

KEY_CASOUT

public static final java.lang.String KEY_CASOUT

See Also:

Constant Field Values

Constructor Detail

SearchIndexOptions

public SearchIndexOptions()

SearchIndexOptions

public SearchIndexOptions(CASActionOptions options)

Method Detail

getServerDefaultValue

public java.lang.Object getServerDefaultValue(java.lang.String key)

Description copied from class: CASActionOptions

Gets the server default value, if known.

Overrides:

getServerDefaultValue in class CASActionOptions

Parameters:

key - The parameter key

Returns:

THe default value, or null if not known

getIndex

public Castable getIndex()

setIndex

public SearchIndexOptions setIndex(Castable value)

Sets the value of parameter 'index': specifies the name of the input index table.

Parameters:

value - The value

Returns:

The options object

getJson

public java.lang.String getJson()

setJson

public SearchIndexOptions setJson(java.lang.String value)

Sets the value of parameter 'json': specifies the JSON input that guides the search action, such as simplequery and rangefilter.

Parameters:

value - The value

Returns:

The options object

getQuery

public java.lang.String getQuery()

setQuery

public SearchIndexOptions setQuery(java.lang.String value)

Sets the value of parameter 'query': specifies the input query in json form.

Parameters:

value - The value

Returns:

The options object

getOutput

public java.lang.String getOutput()

setOutput

public SearchIndexOptions setOutput(java.lang.String value)

Sets the value of parameter 'output': specifies the output specification in json form.

Parameters:

value - The value

Returns:

The options object

getAuthUri

public java.lang.String getAuthUri()

setAuthUri

public SearchIndexOptions setAuthUri(java.lang.String value)

Sets the value of parameter 'authUri': specifies the authorization URI for search.

Parameters:

value - The value

Returns:

The options object

getIdVarName

public java.lang.String getIdVarName()

setIdVarName

public SearchIndexOptions setIdVarName(java.lang.String value)

Sets the value of parameter 'idVarName': User-defined ID name.

Parameters:

value - The value

Returns:

The options object

getRelVarName

public java.lang.String getRelVarName()

setRelVarName

public SearchIndexOptions setRelVarName(java.lang.String value)

Sets the value of parameter 'relVarName': User-defined relevance name.

Parameters:

value - The value

Returns:

The options object

getSortLocale

public java.lang.String getSortLocale()

setSortLocale

public SearchIndexOptions setSortLocale(java.lang.String value)

Sets the value of parameter 'sortLocale': specifies locale to use for comparisons during sort.

Parameters:

value - The value

Returns:

The options object

getJsonOut

public java.lang.Boolean getJsonOut()

setJsonOut

public SearchIndexOptions setJsonOut(java.lang.Boolean value)

Sets the value of parameter 'jsonOut': requests a json output of the results. The server default is TRUE.

Parameters:

value - The value

Returns:

The options object

getCasOut

public Casouttable getCasOut()

setCasOut

public SearchIndexOptions setCasOut(Casouttable value)

Sets the value of parameter 'casOut': specifies the name of the raw output table. This table can also be used as an input file to aggregation. This is an optional parameter.

Parameters:

value - The value

Returns:

The options object