com.sas.cas.actions.network

Class ShortestPathOptions

java.lang.Object

com.sas.cas.CASActionOptions

com.sas.cas.CASGeneratedActionOptions

com.sas.cas.actions.network.ShortestPathOptions

All Implemented Interfaces:

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

public class ShortestPathOptions
extends CASGeneratedActionOptions

Options for shortestPath: Calculates the shortest paths between pairs of nodes in a graph.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ShortestPathOptions.DIRECTION
static class	ShortestPathOptions.LOGLEVEL

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_DIRECTION
static java.lang.String	KEY_DISPLAY
static java.lang.String	KEY_INCLUDESELFLINK
static java.lang.String	KEY_INDEXOFFSET
static java.lang.String	KEY_LINKS
static java.lang.String	KEY_LINKSVAR
static java.lang.String	KEY_LOGFREQTIME
static java.lang.String	KEY_LOGLEVEL
static java.lang.String	KEY_MAXPATHWEIGHT
static java.lang.String	KEY_NODES
static java.lang.String	KEY_NODESSUBSET
static java.lang.String	KEY_NODESSUBSETVAR
static java.lang.String	KEY_NODESVAR
static java.lang.String	KEY_NTHREADS
static java.lang.String	KEY_OUTLINKS
static java.lang.String	KEY_OUTNODES
static java.lang.String	KEY_OUTPATHS
static java.lang.String	KEY_OUTPUTTABLES
static java.lang.String	KEY_OUTWEIGHTS
static java.lang.String	KEY_SINK
static java.lang.String	KEY_SOURCE
static java.lang.String	KEY_STANDARDIZEDLABELS

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
ShortestPathOptions()
ShortestPathOptions(CASActionOptions options)

Method Summary

Modifier and Type	Method and Description
ShortestPathOptions.DIRECTION	getDirection()
DisplayTables	getDisplay()
java.lang.Boolean	getIncludeSelfLink()
java.lang.Integer	getIndexOffset()
Castable	getLinks()
LinksVarT	getLinksVar()
java.lang.Integer	getLogFreqTime()
java.lang.Integer	getLogFrequencyTime()
ShortestPathOptions.LOGLEVEL	getLogLevel()
java.lang.Double	getMaxPathWeight()
Castable	getNodes()
Castable	getNodesSubset()
NodesSubsetVarT	getNodesSubsetVar()
NodesVarT	getNodesVar()
java.lang.Integer	getNThreads()
Casouttable	getOut()
Casouttable	getOutLinks()
Casouttable	getOutNodes()
Casouttable	getOutPaths()
OutputTables	getOutputTables()
Casouttable	getOutWeights()
java.lang.Object	getServerDefaultValue(java.lang.String key) Gets the server default value, if known.
java.lang.Object	getSink()
java.lang.Object	getSource()
java.lang.Boolean	getStandardizedLabels()
ShortestPathOptions	setDirection(ShortestPathOptions.DIRECTION value) Sets the value of parameter 'direction': specifies whether the input graph should be considered directed or undirected.
ShortestPathOptions	setDisplay(DisplayTables value) Sets the value of parameter 'display': specifies a list of result tables to send to the client for display.
ShortestPathOptions	setIncludeSelfLink(java.lang.Boolean value) Sets the value of parameter 'includeSelfLink': when set to True, includes self-links when an input graph is read.
ShortestPathOptions	setIndexOffset(java.lang.Integer value) Sets the value of parameter 'indexOffset': specifies the index offset for identifiers in the log and results output data tables.
ShortestPathOptions	setLinks(Castable value) Sets the value of parameter 'links': specifies the input data table that contains the graph link information.
ShortestPathOptions	setLinksVar(LinksVarT value) Sets the value of parameter 'linksVar': enables you to explicitly specify the data variable names for the links table.
ShortestPathOptions	setLogFreqTime(java.lang.Integer value) Sets the value of parameter 'logFreqTime': controls the frequency, in number of seconds, for displaying iteration logs.
ShortestPathOptions	setLogFrequencyTime(java.lang.Integer value)
ShortestPathOptions	setLogLevel(ShortestPathOptions.LOGLEVEL value) Sets the value of parameter 'logLevel': controls the amount of information that is displayed in the SAS log.
ShortestPathOptions	setMaxPathWeight(java.lang.Double value) Sets the value of parameter 'maxPathWeight': specifies the maximum path weight.
ShortestPathOptions	setNodes(Castable value) Sets the value of parameter 'nodes': specifies the input data table that contains the graph node information.
ShortestPathOptions	setNodesSubset(Castable value) Sets the value of parameter 'nodesSubset': specifies the input data table that contains the graph node subset information.
ShortestPathOptions	setNodesSubsetVar(NodesSubsetVarT value) Sets the value of parameter 'nodesSubsetVar': enables you to explicitly specify the data variable names for the nodes subset table.
ShortestPathOptions	setNodesVar(NodesVarT value) Sets the value of parameter 'nodesVar': enables you to explicitly specify the data variable names for the nodes table.
ShortestPathOptions	setNThreads(java.lang.Integer value) Sets the value of parameter 'nThreads': specifies the maximum number of threads to use for multithreaded processing.
ShortestPathOptions	setOut(Casouttable value)
ShortestPathOptions	setOutLinks(Casouttable value) Sets the value of parameter 'outLinks': specifies the output data table to contain the graph node information along with any results from the algorithms that calculate metrics on nodes.
ShortestPathOptions	setOutNodes(Casouttable value) Sets the value of parameter 'outNodes': specifies the output data table to contain the graph link information along with any results from the algorithms that calculate metrics on links.
ShortestPathOptions	setOutPaths(Casouttable value) Sets the value of parameter 'outPaths': specifies the output data table to contain the shortest paths.
ShortestPathOptions	setOutputTables(OutputTables value) Sets the value of parameter 'outputTables': lists the result table names that are saved as CAS tables on the server.
ShortestPathOptions	setOutWeights(Casouttable value) Sets the value of parameter 'outWeights': specifies the output data table to contain the shortest path summaries.
ShortestPathOptions	setSink(java.lang.Double value) Sets the value of parameter 'sink' for alternative 2.
ShortestPathOptions	setSink(java.lang.String value) Sets the value of parameter 'sink' for alternative 1.
ShortestPathOptions	setSource(java.lang.Double value) Sets the value of parameter 'source' for alternative 2.
ShortestPathOptions	setSource(java.lang.String value) Sets the value of parameter 'source' for alternative 1.
ShortestPathOptions	setStandardizedLabels(java.lang.Boolean value) Sets the value of parameter 'standardizedLabels': when set to True, specifies that the input graph data are in a standardized format.

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_DISPLAY

public static final java.lang.String KEY_DISPLAY

See Also:

Constant Field Values

KEY_OUTPUTTABLES

public static final java.lang.String KEY_OUTPUTTABLES

See Also:

Constant Field Values

KEY_DIRECTION

public static final java.lang.String KEY_DIRECTION

See Also:

Constant Field Values

KEY_INCLUDESELFLINK

public static final java.lang.String KEY_INCLUDESELFLINK

See Also:

Constant Field Values

KEY_LOGLEVEL

public static final java.lang.String KEY_LOGLEVEL

See Also:

Constant Field Values

KEY_LOGFREQTIME

public static final java.lang.String KEY_LOGFREQTIME

See Also:

Constant Field Values

KEY_STANDARDIZEDLABELS

public static final java.lang.String KEY_STANDARDIZEDLABELS

See Also:

Constant Field Values

KEY_LINKS

public static final java.lang.String KEY_LINKS

See Also:

Constant Field Values

KEY_NODES

public static final java.lang.String KEY_NODES

See Also:

Constant Field Values

KEY_NODESSUBSET

public static final java.lang.String KEY_NODESSUBSET

See Also:

Constant Field Values

KEY_OUTNODES

public static final java.lang.String KEY_OUTNODES

See Also:

Constant Field Values

KEY_OUTLINKS

public static final java.lang.String KEY_OUTLINKS

See Also:

Constant Field Values

KEY_LINKSVAR

public static final java.lang.String KEY_LINKSVAR

See Also:

Constant Field Values

KEY_NODESVAR

public static final java.lang.String KEY_NODESVAR

See Also:

Constant Field Values

KEY_NODESSUBSETVAR

public static final java.lang.String KEY_NODESSUBSETVAR

See Also:

Constant Field Values

KEY_NTHREADS

public static final java.lang.String KEY_NTHREADS

See Also:

Constant Field Values

KEY_INDEXOFFSET

public static final java.lang.String KEY_INDEXOFFSET

See Also:

Constant Field Values

KEY_OUTPATHS

public static final java.lang.String KEY_OUTPATHS

See Also:

Constant Field Values

KEY_OUTWEIGHTS

public static final java.lang.String KEY_OUTWEIGHTS

See Also:

Constant Field Values

KEY_SOURCE

public static final java.lang.String KEY_SOURCE

See Also:

Constant Field Values

KEY_SINK

public static final java.lang.String KEY_SINK

See Also:

Constant Field Values

KEY_MAXPATHWEIGHT

public static final java.lang.String KEY_MAXPATHWEIGHT

See Also:

Constant Field Values

Constructor Detail

ShortestPathOptions

public ShortestPathOptions()

ShortestPathOptions

public ShortestPathOptions(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

getDisplay

public DisplayTables getDisplay()

setDisplay

public ShortestPathOptions setDisplay(DisplayTables value)

Sets the value of parameter 'display': specifies a list of result tables to send to the client for display.

Parameters:

value - The value

Returns:

The options object

getOutputTables

public OutputTables getOutputTables()

setOutputTables

public ShortestPathOptions setOutputTables(OutputTables value)

Sets the value of parameter 'outputTables': lists the result table names that are saved as CAS tables on the server.

Parameters:

value - The value

Returns:

The options object

getDirection

public ShortestPathOptions.DIRECTION getDirection()

setDirection

public ShortestPathOptions setDirection(ShortestPathOptions.DIRECTION value)

Sets the value of parameter 'direction': specifies whether the input graph should be considered directed or undirected. . The server default is DIRECTION.UNDIRECTED.

Parameters:

value - The value

Returns:

The options object

getIncludeSelfLink

public java.lang.Boolean getIncludeSelfLink()

setIncludeSelfLink

public ShortestPathOptions setIncludeSelfLink(java.lang.Boolean value)

Sets the value of parameter 'includeSelfLink': when set to True, includes self-links when an input graph is read. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getLogLevel

public ShortestPathOptions.LOGLEVEL getLogLevel()

setLogLevel

public ShortestPathOptions setLogLevel(ShortestPathOptions.LOGLEVEL value)

Sets the value of parameter 'logLevel': controls the amount of information that is displayed in the SAS log. The server default is LOGLEVEL.BASIC.

Parameters:

value - The value

Returns:

The options object

getLogFreqTime

public java.lang.Integer getLogFreqTime()

getLogFrequencyTime

public java.lang.Integer getLogFrequencyTime()

setLogFreqTime

public ShortestPathOptions setLogFreqTime(java.lang.Integer value)

Sets the value of parameter 'logFreqTime': controls the frequency, in number of seconds, for displaying iteration logs. This parameter is useful for computationally intensive algorithms. Setting this value too low can hurt algorithm performance. The value of the parameter can be any integer greater than or equal to 1. . The server default is 5.

Parameters:

value - The value

Returns:

The options object

setLogFrequencyTime

public ShortestPathOptions setLogFrequencyTime(java.lang.Integer value)

getStandardizedLabels

public java.lang.Boolean getStandardizedLabels()

setStandardizedLabels

public ShortestPathOptions setStandardizedLabels(java.lang.Boolean value)

Sets the value of parameter 'standardizedLabels': when set to True, specifies that the input graph data are in a standardized format. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getLinks

public Castable getLinks()

setLinks

public ShortestPathOptions setLinks(Castable value)

Sets the value of parameter 'links': specifies the input data table that contains the graph link information.

Parameters:

value - The value

Returns:

The options object

getNodes

public Castable getNodes()

setNodes

public ShortestPathOptions setNodes(Castable value)

Sets the value of parameter 'nodes': specifies the input data table that contains the graph node information. .

Parameters:

value - The value

Returns:

The options object

getNodesSubset

public Castable getNodesSubset()

setNodesSubset

public ShortestPathOptions setNodesSubset(Castable value)

Sets the value of parameter 'nodesSubset': specifies the input data table that contains the graph node subset information. .

Parameters:

value - The value

Returns:

The options object

getOutNodes

public Casouttable getOutNodes()

setOutNodes

public ShortestPathOptions setOutNodes(Casouttable value)

Sets the value of parameter 'outNodes': specifies the output data table to contain the graph link information along with any results from the algorithms that calculate metrics on links. .

Parameters:

value - The value

Returns:

The options object

getOutLinks

public Casouttable getOutLinks()

setOutLinks

public ShortestPathOptions setOutLinks(Casouttable value)

Sets the value of parameter 'outLinks': specifies the output data table to contain the graph node information along with any results from the algorithms that calculate metrics on nodes. .

Parameters:

value - The value

Returns:

The options object

getLinksVar

public LinksVarT getLinksVar()

setLinksVar

public ShortestPathOptions setLinksVar(LinksVarT value)

Sets the value of parameter 'linksVar': enables you to explicitly specify the data variable names for the links table.

Parameters:

value - The value

Returns:

The options object

getNodesVar

public NodesVarT getNodesVar()

setNodesVar

public ShortestPathOptions setNodesVar(NodesVarT value)

Sets the value of parameter 'nodesVar': enables you to explicitly specify the data variable names for the nodes table.

Parameters:

value - The value

Returns:

The options object

getNodesSubsetVar

public NodesSubsetVarT getNodesSubsetVar()

setNodesSubsetVar

public ShortestPathOptions setNodesSubsetVar(NodesSubsetVarT value)

Sets the value of parameter 'nodesSubsetVar': enables you to explicitly specify the data variable names for the nodes subset table.

Parameters:

value - The value

Returns:

The options object

getNThreads

public java.lang.Integer getNThreads()

setNThreads

public ShortestPathOptions setNThreads(java.lang.Integer value)

Sets the value of parameter 'nThreads': specifies the maximum number of threads to use for multithreaded processing.

Parameters:

value - The value

Returns:

The options object

getIndexOffset

public java.lang.Integer getIndexOffset()

setIndexOffset

public ShortestPathOptions setIndexOffset(java.lang.Integer value)

Sets the value of parameter 'indexOffset': specifies the index offset for identifiers in the log and results output data tables. For example, if three entities are found, they would be labeled entity 1, 2, and 3 by default. If the value of indexOffset is 4, they would be labeled entity 4, 5, and 6. . The server default is 0.

Parameters:

value - The value

Returns:

The options object

getOutPaths

public Casouttable getOutPaths()

getOut

public Casouttable getOut()

setOutPaths

public ShortestPathOptions setOutPaths(Casouttable value)

Sets the value of parameter 'outPaths': specifies the output data table to contain the shortest paths.

Parameters:

value - The value

Returns:

The options object

setOut

public ShortestPathOptions setOut(Casouttable value)

getOutWeights

public Casouttable getOutWeights()

setOutWeights

public ShortestPathOptions setOutWeights(Casouttable value)

Sets the value of parameter 'outWeights': specifies the output data table to contain the shortest path summaries. .

Parameters:

value - The value

Returns:

The options object

getSource

public java.lang.Object getSource()

setSource

public ShortestPathOptions setSource(java.lang.String value)

Sets the value of parameter 'source' for alternative 1.

Parameters:

value - The value

Returns:

The options object

setSource

public ShortestPathOptions setSource(java.lang.Double value)

Sets the value of parameter 'source' for alternative 2.

Parameters:

value - The value

Returns:

The options object

getSink

public java.lang.Object getSink()

setSink

public ShortestPathOptions setSink(java.lang.String value)

Sets the value of parameter 'sink' for alternative 1.

Parameters:

value - The value

Returns:

The options object

setSink

public ShortestPathOptions setSink(java.lang.Double value)

Sets the value of parameter 'sink' for alternative 2.

Parameters:

value - The value

Returns:

The options object

getMaxPathWeight

public java.lang.Double getMaxPathWeight()

setMaxPathWeight

public ShortestPathOptions setMaxPathWeight(java.lang.Double value)

Sets the value of parameter 'maxPathWeight': specifies the maximum path weight. Any shortest path whose sum of link weights is greater than this value is removed from the results. The default is the largest number that can be represented by a double, which causes no paths to be removed from the results. .

Parameters:

value - The value

Returns:

The options object