com.sas.cas.actions.network

Class ReachOptions

java.lang.Object

com.sas.cas.CASActionOptions

com.sas.cas.CASGeneratedActionOptions

com.sas.cas.actions.network.ReachOptions

All Implemented Interfaces:

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

public class ReachOptions
extends CASGeneratedActionOptions

Options for reach: Calculates the reach (ego-network) of a graph.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReachOptions.DIRECTION
static class	ReachOptions.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_DIGRAPH
static java.lang.String	KEY_DIRECTION
static java.lang.String	KEY_DISPLAY
static java.lang.String	KEY_EACHSOURCE
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_MAXREACH
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_OUTCOUNTS
static java.lang.String	KEY_OUTLINKS
static java.lang.String	KEY_OUTNODES
static java.lang.String	KEY_OUTPUTTABLES
static java.lang.String	KEY_OUTREACHLINKS
static java.lang.String	KEY_OUTREACHNODES
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
ReachOptions()
ReachOptions(CASActionOptions options)

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getDigraph()
ReachOptions.DIRECTION	getDirection()
DisplayTables	getDisplay()
java.lang.Boolean	getEachSource()
java.lang.Boolean	getIncludeSelfLink()
java.lang.Integer	getIndexOffset()
Castable	getLinks()
LinksVarT	getLinksVar()
java.lang.Integer	getLogFreqTime()
java.lang.Integer	getLogFrequencyTime()
ReachOptions.LOGLEVEL	getLogLevel()
java.lang.Integer	getMaxReach()
Castable	getNodes()
Castable	getNodesSubset()
NodesSubsetVarT	getNodesSubsetVar()
NodesVarT	getNodesVar()
java.lang.Integer	getNThreads()
Casouttable	getOutCounts()
Casouttable	getOutLinks()
Casouttable	getOutNodes()
OutputTables	getOutputTables()
Casouttable	getOutReachLinks()
Casouttable	getOutReachNodes()
java.lang.Object	getServerDefaultValue(java.lang.String key) Gets the server default value, if known.
java.lang.Boolean	getStandardizedLabels()
ReachOptions	setDigraph(java.lang.Boolean value) Sets the value of parameter 'digraph': when set to True, calculates the directed reach counts when computing the reach networks and includes the directed counts in the resulting output data table, which is specified in the outCounts parameter.
ReachOptions	setDirection(ReachOptions.DIRECTION value) Sets the value of parameter 'direction': specifies whether the input graph should be considered directed or undirected.
ReachOptions	setDisplay(DisplayTables value) Sets the value of parameter 'display': specifies a list of result tables to send to the client for display.
ReachOptions	setEachSource(java.lang.Boolean value) Sets the value of parameter 'eachSource': treats each node as a source and calculates a reach network from each one.
ReachOptions	setIncludeSelfLink(java.lang.Boolean value) Sets the value of parameter 'includeSelfLink': when set to True, includes self-links when an input graph is read.
ReachOptions	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.
ReachOptions	setLinks(Castable value) Sets the value of parameter 'links': specifies the input data table that contains the graph link information.
ReachOptions	setLinksVar(LinksVarT value) Sets the value of parameter 'linksVar': enables you to explicitly specify the data variable names for the links table.
ReachOptions	setLogFreqTime(java.lang.Integer value) Sets the value of parameter 'logFreqTime': controls the frequency, in number of seconds, for displaying iteration logs.
ReachOptions	setLogFrequencyTime(java.lang.Integer value)
ReachOptions	setLogLevel(ReachOptions.LOGLEVEL value) Sets the value of parameter 'logLevel': controls the amount of information that is displayed in the SAS log.
ReachOptions	setMaxReach(java.lang.Integer value) Sets the value of parameter 'maxReach': specifies the maximum number of links from each source node in a reach network.
ReachOptions	setNodes(Castable value) Sets the value of parameter 'nodes': specifies the input data table that contains the graph node information.
ReachOptions	setNodesSubset(Castable value) Sets the value of parameter 'nodesSubset': specifies the input data table that contains the graph node subset information.
ReachOptions	setNodesSubsetVar(NodesSubsetVarT value) Sets the value of parameter 'nodesSubsetVar': enables you to explicitly specify the data variable names for the nodes subset table.
ReachOptions	setNodesVar(NodesVarT value) Sets the value of parameter 'nodesVar': enables you to explicitly specify the data variable names for the nodes table.
ReachOptions	setNThreads(java.lang.Integer value) Sets the value of parameter 'nThreads': specifies the maximum number of threads to use for multithreaded processing.
ReachOptions	setOutCounts(Casouttable value) Sets the value of parameter 'outCounts': specifies the output data table that describes the number of nodes in each reach network for each set of source nodes.
ReachOptions	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.
ReachOptions	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.
ReachOptions	setOutputTables(OutputTables value) Sets the value of parameter 'outputTables': lists the result table names that are saved as CAS tables on the server.
ReachOptions	setOutReachLinks(Casouttable value) Sets the value of parameter 'outReachLinks': specifies the output data table that describes the links in each reach network that are found from each set of source nodes.
ReachOptions	setOutReachNodes(Casouttable value) Sets the value of parameter 'outReachNodes': specifies the output data table that describes the nodes in each reach network that are found from each set of source nodes.
ReachOptions	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_OUTREACHLINKS

public static final java.lang.String KEY_OUTREACHLINKS

See Also:

Constant Field Values

KEY_OUTREACHNODES

public static final java.lang.String KEY_OUTREACHNODES

See Also:

Constant Field Values

KEY_OUTCOUNTS

public static final java.lang.String KEY_OUTCOUNTS

See Also:

Constant Field Values

KEY_DIGRAPH

public static final java.lang.String KEY_DIGRAPH

See Also:

Constant Field Values

KEY_EACHSOURCE

public static final java.lang.String KEY_EACHSOURCE

See Also:

Constant Field Values

KEY_MAXREACH

public static final java.lang.String KEY_MAXREACH

See Also:

Constant Field Values

Constructor Detail

ReachOptions

public ReachOptions()

ReachOptions

public ReachOptions(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 ReachOptions 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 ReachOptions 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 ReachOptions.DIRECTION getDirection()

setDirection

public ReachOptions setDirection(ReachOptions.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 ReachOptions 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 ReachOptions.LOGLEVEL getLogLevel()

setLogLevel

public ReachOptions setLogLevel(ReachOptions.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 ReachOptions 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 ReachOptions setLogFrequencyTime(java.lang.Integer value)

getStandardizedLabels

public java.lang.Boolean getStandardizedLabels()

setStandardizedLabels

public ReachOptions 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 ReachOptions 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 ReachOptions 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 ReachOptions 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 ReachOptions 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 ReachOptions 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 ReachOptions 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 ReachOptions 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 ReachOptions 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 ReachOptions 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 ReachOptions 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

getOutReachLinks

public Casouttable getOutReachLinks()

setOutReachLinks

public ReachOptions setOutReachLinks(Casouttable value)

Sets the value of parameter 'outReachLinks': specifies the output data table that describes the links in each reach network that are found from each set of source nodes. Output of the reach network links can sometimes be more computationally expensive compared to calculating only the nodes or counts in the reach networks. .

Parameters:

value - The value

Returns:

The options object

getOutReachNodes

public Casouttable getOutReachNodes()

setOutReachNodes

public ReachOptions setOutReachNodes(Casouttable value)

Sets the value of parameter 'outReachNodes': specifies the output data table that describes the nodes in each reach network that are found from each set of source nodes.

Parameters:

value - The value

Returns:

The options object

getOutCounts

public Casouttable getOutCounts()

setOutCounts

public ReachOptions setOutCounts(Casouttable value)

Sets the value of parameter 'outCounts': specifies the output data table that describes the number of nodes in each reach network for each set of source nodes. .

Parameters:

value - The value

Returns:

The options object

getDigraph

public java.lang.Boolean getDigraph()

setDigraph

public ReachOptions setDigraph(java.lang.Boolean value)

Sets the value of parameter 'digraph': when set to True, calculates the directed reach counts when computing the reach networks and includes the directed counts in the resulting output data table, which is specified in the outCounts parameter. This parameter is ignored unless the maxReach parameter is set to 1. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getEachSource

public java.lang.Boolean getEachSource()

setEachSource

public ReachOptions setEachSource(java.lang.Boolean value)

Sets the value of parameter 'eachSource': treats each node as a source and calculates a reach network from each one. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getMaxReach

public java.lang.Integer getMaxReach()

setMaxReach

public ReachOptions setMaxReach(java.lang.Integer value)

Sets the value of parameter 'maxReach': specifies the maximum number of links from each source node in a reach network. . The server default is 1.

Parameters:

value - The value

Returns:

The options object