public class Splus extends java.lang.Object implements SplusObject, java.io.Serializable
Splus
object.Modifier and Type | Field and Description |
---|---|
static int |
MAX_SPXML_SIZE_DEFAULT |
Constructor and Description |
---|
Splus()
Constructs an
Splus object. |
Splus(DisplayOptions displayOptions,
Header header,
java.util.List<SplusObject> value)
Constructs an
Splus object, specifying the display options,
the header, and values. |
Splus(DisplayOptions displayOptions,
Header header,
SplusObject... value)
Constructs an
Splus object, specifying the display options,
the header, and the value. |
Splus(SplusObject... value)
Constructs an
Splus object with default DisplayOptions and Header
objects. |
Modifier and Type | Method and Description |
---|---|
boolean[] |
getAsBooleanArray()
Retrieves the value of this
Splus object as an array of bools (logical vectors). |
DataFrame |
getAsDataFrame()
Retrieves the value of this
Splus object as a DataFrame . |
double[] |
getAsDoubleArray()
Retrieves the value of this
Splus object as an array of doubles. |
int[] |
getAsIntArray()
Retrieves the value of this
Splus object as an array of ints . |
Matrix |
getAsMatrix()
Retrieves value of this
Splus object as a Matrix . |
MultiDimensionalArray |
getAsMultiDimensionalArray()
Retrieves the value of this
Splus object as a MultiDimensionalArray . |
java.lang.String |
getAsString()
Helper method to get a first string of a vector returned.
|
java.lang.String[] |
getAsStringArray()
Retrieves the value of this
Splus object as a string array. |
Vector |
getAsVector()
Retrieves the value of this
Splus object as a Vector . |
DisplayOptions |
getDisplayOptions()
Retrieves the object's display options.
|
<T extends SplusObject> |
getFirstValue()
Retrieves the first value of the value array.
|
Header |
getHeader()
Retrieves the object's header.
|
java.lang.String |
getName()
This attribute does not exist in SPXML.
|
java.util.List<SplusObject> |
getValue()
Retrieves the generic object's value.
|
void |
setDisplayOptions(DisplayOptions displayOptions)
Sets the object's display options.
|
void |
setHeader(Header header)
Sets the object's header.
|
void |
setName(java.lang.String name)
Sets the name of this.
|
void |
setValue(java.util.List<SplusObject> value)
Sets the
Splus object's value. |
public static final int MAX_SPXML_SIZE_DEFAULT
public Splus()
Splus
object.public Splus(DisplayOptions displayOptions, Header header, SplusObject... value)
Splus
object, specifying the display options,
the header, and the value.displayOptions
- A DisplayOptions
object.header
- A Header
object.value
- The SplusObject
value.DisplayOptions
,
Header
,
SplusObject
public Splus(SplusObject... value)
Splus
object with default DisplayOptions
and Header
objects.value
- public Splus(DisplayOptions displayOptions, Header header, java.util.List<SplusObject> value)
Splus
object, specifying the display options,
the header, and values.displayOptions
- A DisplayOptions
object.header
- A Header
object.value
- A list of SplusObject
values.DisplayOptions
,
Header
,
SplusObject
public DisplayOptions getDisplayOptions()
DisplayOptions
object.DisplayOptions
public void setDisplayOptions(DisplayOptions displayOptions)
displayOptions
- A DisplayOptions
object.DisplayOptions
public Header getHeader()
Header
object.Header
public void setHeader(Header header)
header
- A Header
object.Header
public java.util.List<SplusObject> getValue()
SplusObject
specifying the value.public void setValue(java.util.List<SplusObject> value)
Splus
object's value.value
- An SplusObject
specifying the value.public java.lang.String getAsString()
public java.lang.String[] getAsStringArray()
Splus
object as a string array. Assumes that this
object contains a character vector as a first element.public int[] getAsIntArray()
Splus
object as an array of ints
.
Assumes that this object contains an integer vector as a first element.ints
.public Vector getAsVector()
Splus
object as a Vector
. Assumes that this object contains
a Vector
as a first element.Vector
.Vector
public Matrix getAsMatrix()
Splus
object as a Matrix
. Assumes that this object
contains a Matrix
as a first element.Matrix
.Matrix
public MultiDimensionalArray getAsMultiDimensionalArray()
Splus
object as a MultiDimensionalArray
. Assumes that this
object contains a MultiDimensionalArray
as a first element.MultiDimensionalArray
MultiDimensionalArray
public DataFrame getAsDataFrame()
Splus
object as a DataFrame
. Assumes that this
object contains a DataFrame
as a first element.DataFrame
DataFrame
public boolean[] getAsBooleanArray()
Splus
object as an array of bools (logical vectors). Assumes that this object
contains an logical vector as a first element.public double[] getAsDoubleArray()
Splus
object as an array of doubles. Assumes that this object
contains an numeric vector as a first element.public <T extends SplusObject> T getFirstValue()
T
- Any class derived from SplusObject
, such as Vector
or Matrix
.public java.lang.String getName()
SplusObject
. The default value is SPLUS
.getName
in interface SplusObject
public void setName(java.lang.String name)
setName
in interface SplusObject
name
- a String.