com.sas.cas.samples

Class BaseSample

java.lang.Object

com.sas.cas.samples.BaseSample

Direct Known Subclasses:

ActionEventSample, AddCaslibSample, AddCSVSample, AddCSVWithTransformSample, AddFixedCSVSample, AddTableSample, BatchSample, CaslibInfoSample, ColumnInfoSample, CrosstabSample, DispositionEventSample, EmptyTableSample, FetchByCursorSample, FetchByRowSample, FetchSample, FileInfoSample, HelpSample, ListNodesLuaSample, ListNodesSample, LoadActionSetSample, LogEventSample, LuaSample, NumrowsSample, PerformanceEventSample, PingSample, QueryActionSetSample, ReflectionSample, ResultEventSample, SerializedOptionsSample, ServerStatusSample, ShutdownSample, SocketEventSample, SummarySample, TableAttributesSample, TableEventSample, TableExistsSample, TableInfoSample, UploadSample, VerifySessionSample

public abstract class BaseSample
extends java.lang.Object

Base class for all sample applications.

If a defaults file exists in the current work directory (CASClient.properties), it will be used to load default values. The defaults file must be in "Properties" format (key/value pairs).

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULTS_FILE_NAME
protected static java.util.ResourceBundle	rb

Constructor Summary

Constructors

Constructor and Description
BaseSample()

Method Summary

Modifier and Type	Method and Description
void	argsToProperties(java.lang.String[] args, java.util.Properties properties) Convert the command line arguments to a Map object.
void	close()
CASClientInterface	createCASClient() Creates a new CASClient instance.
void	createTarget()
protected void	doHelp()
abstract void	doSample()
boolean	getBooleanProperty(java.lang.String name)
boolean	getBooleanProperty(java.lang.String name, boolean defaultValue)
protected java.lang.String	getClassName()
CASClientInterface	getClient()
protected java.lang.Object	getDefaultValue(java.lang.String name)
protected HelpOption	getHelpOption(java.lang.String name)
abstract HelpOption[]	getHelpOptions()
int	getIntegerProperty(java.lang.String name) Gets the value of the named property as an integer value.
long	getLongProperty(java.lang.String name)
java.util.Properties	getProperties()
java.lang.String	getProperty(java.lang.String name) Gets the value of the named property.
java.lang.String	getRequiredProperty(java.lang.String name) Attempts to get a required property.
java.lang.String	getResourceString(java.lang.String key) Provides an opportunity for classes to override if a resource is not found.
java.lang.String[]	getStringArrayProperty(java.lang.String name) Gets the value of a named property as a String array.
void	initialize(CASClient client) Provides an opportunity to perform CASClient specific initialization.
void	initialize(CASRestClient client) Provides an opportunity to perform CASRestClient specific initialization.
void	invokeSample(java.lang.String[] args)
boolean	isActionSetLoaded(java.lang.String actionSetName) Invokes the querylib action on the server to determine if the given action set has been loaded.
void	loadActionSet(java.lang.String actionSetName) Attempts to load the given action set if it is not already loaded.
protected void	loadDefaults(java.lang.String fileName, java.util.Properties properties)
protected java.lang.String	pad(java.lang.String s, int len)
static void	printDisposition(CASActionResults<?> results) Prints any performance events to stdout.
static void	printEvents(CASActionResults<?> results) Prints any result events to stdout.
static void	printLog(CASActionResults<?> results) Prints any log events to stdout.
static void	printPerformance(CASActionResults<?> results) Prints any performance events to stdout.
static void	printResultValues(CASActionResults<CASValue> results) Prints any result values to stdout.
static void	printResultValues(CASActionResults<CASValue> results, boolean csv) Prints any result values to stdout.
java.lang.String[]	propertiesToArgs(java.util.Properties properties)
void	setClient(CASClientInterface client)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

rb

protected static final java.util.ResourceBundle rb

DEFAULTS_FILE_NAME

public static final java.lang.String DEFAULTS_FILE_NAME

See Also:

Constant Field Values

Constructor Detail

BaseSample

public BaseSample()

Method Detail

doSample

public abstract void doSample()
                       throws java.lang.Exception

Throws:

java.lang.Exception

getHelpOptions

public abstract HelpOption[] getHelpOptions()

invokeSample

public void invokeSample(java.lang.String[] args)
                  throws java.lang.Exception

Throws:

java.lang.Exception

createTarget

public void createTarget()
                  throws java.lang.Exception

Throws:

java.lang.Exception

getClient

public CASClientInterface getClient()

setClient

public void setClient(CASClientInterface client)

getProperties

public java.util.Properties getProperties()

close

public void close()

doHelp

protected void doHelp()

pad

protected java.lang.String pad(java.lang.String s,
                               int len)

getClassName

protected java.lang.String getClassName()

loadDefaults

protected void loadDefaults(java.lang.String fileName,
                            java.util.Properties properties)
                     throws java.io.IOException

Throws:

java.io.IOException

getDefaultValue

protected java.lang.Object getDefaultValue(java.lang.String name)

getHelpOption

protected HelpOption getHelpOption(java.lang.String name)

argsToProperties

public void argsToProperties(java.lang.String[] args,
                             java.util.Properties properties)

Convert the command line arguments to a Map object. The format is "name=value".

Parameters:

args - The arguments

properties - The target properties object

propertiesToArgs

public java.lang.String[] propertiesToArgs(java.util.Properties properties)

createCASClient

public CASClientInterface createCASClient()
                                   throws CASException,
                                          java.io.IOException

Creates a new CASClient instance.

Returns:

The new CASClient object

Throws:

CASException

java.io.IOException

initialize

public void initialize(CASClient client)
                throws CASException,
                       java.io.IOException

Provides an opportunity to perform CASClient specific initialization.

Parameters:

client - The client instance

Throws:

CASException

java.io.IOException

initialize

public void initialize(CASRestClient client)
                throws CASException,
                       java.io.IOException

Provides an opportunity to perform CASRestClient specific initialization.

Parameters:

client - The client instance

Throws:

CASException

java.io.IOException

getRequiredProperty

public java.lang.String getRequiredProperty(java.lang.String name)
                                     throws CASException

Attempts to get a required property. If the property does not exist an exception will be thrown.

Parameters:

name - The property key

Returns:

The property value

Throws:

CASException

getProperty

public java.lang.String getProperty(java.lang.String name)

Gets the value of the named property.

Parameters:

name - The property name

Returns:

The value, or the default value if the property name was not found

getStringArrayProperty

public java.lang.String[] getStringArrayProperty(java.lang.String name)

Gets the value of a named property as a String array.

Parameters:

name - The property name

Returns:

The value, or null if not specified

getIntegerProperty

public int getIntegerProperty(java.lang.String name)

Gets the value of the named property as an integer value.

Parameters:

name - The property name

Returns:

The value

getLongProperty

public long getLongProperty(java.lang.String name)

getBooleanProperty

public boolean getBooleanProperty(java.lang.String name)

getBooleanProperty

public boolean getBooleanProperty(java.lang.String name,
                                  boolean defaultValue)

printResultValues

public static void printResultValues(CASActionResults<CASValue> results)

Prints any result values to stdout.

Parameters:

results - The results

printResultValues

public static void printResultValues(CASActionResults<CASValue> results,
                                     boolean csv)

Prints any result values to stdout.

Parameters:

results - The results

csv - if true, tables are printed in CSV format

printEvents

public static void printEvents(CASActionResults<?> results)

Prints any result events to stdout. This includes disposition, performance, and log events.

Parameters:

results - The results

printLog

public static void printLog(CASActionResults<?> results)

Prints any log events to stdout.

Parameters:

results - The results

printPerformance

public static void printPerformance(CASActionResults<?> results)

Prints any performance events to stdout.

Parameters:

results - The results

printDisposition

public static void printDisposition(CASActionResults<?> results)

Prints any performance events to stdout.

Parameters:

results - The results

isActionSetLoaded

public boolean isActionSetLoaded(java.lang.String actionSetName)
                          throws CASException,
                                 java.io.IOException

Invokes the querylib action on the server to determine if the given action set has been loaded.

Parameters:

actionSetName - The action set name

Returns:

true if the action set has been loaded

Throws:

CASException

java.io.IOException

loadActionSet

public void loadActionSet(java.lang.String actionSetName)
                   throws CASException,
                          java.io.IOException

Attempts to load the given action set if it is not already loaded.

Parameters:

actionSetName - The action set name

Throws:

CASException

java.io.IOException

getResourceString

public java.lang.String getResourceString(java.lang.String key)

Provides an opportunity for classes to override if a resource is not found.

Parameters:

key - The key

Returns:

The resource value, or null if not known