visad
Class Text

java.lang.Object
  extended by visad.ThingImpl
      extended by visad.DataImpl
          extended by visad.Scalar
              extended by visad.Text
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.lang.Comparable, Data, ScalarIface, Thing

public class Text
extends Scalar

Text is the class of VisAD scalar data for text strings. The null pointer is used to indicate missing. Text objects are immutable.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class visad.DataImpl
DataImpl.Syncher
 
Field Summary
 
Fields inherited from interface visad.Data
ABS, ACOS, ACOS_DEGREES, ADD, ASIN, ASIN_DEGREES, ATAN, ATAN_DEGREES, ATAN2, ATAN2_DEGREES, CEIL, COS, COS_DEGREES, DEGREES_TO_RADIANS, DEPENDENT, DIVIDE, EXP, FLOOR, INDEPENDENT, INV_ATAN2, INV_ATAN2_DEGREES, INV_DIVIDE, INV_POW, INV_REMAINDER, INV_SUBTRACT, LOG, MAX, MIN, MULTIPLY, NEAREST_NEIGHBOR, NEGATE, NO_ERRORS, NOP, POW, RADIANS_TO_DEGREES, REMAINDER, RINT, ROUND, SIN, SIN_DEGREES, SQRT, SUBTRACT, TAN, TAN_DEGREES, WEIGHTED_AVERAGE
 
Constructor Summary
Text(java.lang.String value)
          construct a Text object with the generic TEXT type (TextType.Generic)
Text(TextType type)
          construct a Text object with the missing value
Text(TextType type, java.lang.String value)
          construct a Text object
 
Method Summary
 Data binary(Data data, int op, int sampling_mode, int error_mode)
          binary operations
 int compareTo(java.lang.Object object)
          Compares this Text to another.
 DataShadow computeRanges(ShadowType type, DataShadow shadow)
          recursive version of computeRanges; would like 'default' visibility here, but must be declared 'public' because it is defined in the Data interface
 boolean equals(java.lang.Object obj)
          Indicates if this Text is semantically identical to an object.
 java.lang.String getValue()
           
 boolean isMissing()
          a method to tell whether data object has a missing value
 java.lang.String longString(java.lang.String pre)
          generates a longer string than generated by toString, indented by pre (a string of blanks)
 java.lang.String toString()
           
 Data unary(int op, int sampling_mode, int error_mode)
          unary operations
 
Methods inherited from class visad.Scalar
addReference, clone, removeReference
 
Methods inherited from class visad.DataImpl
__add__, __add__, __div__, __div__, __mod__, __mod__, __mul__, __mul__, __neg__, __pow__, __pow__, __sub__, __sub__, abs, abs, acos, acos, acosDegrees, acosDegrees, add, add, adjustSamplingError, asin, asin, asinDegrees, asinDegrees, atan, atan, atan2, atan2, atan2Degrees, atan2Degrees, atanDegrees, atanDegrees, binary, ceil, ceil, changeMathType, computeRanges, computeRanges, cos, cos, cosDegrees, cosDegrees, dataClone, divide, divide, exp, exp, floor, floor, getType, local, log, log, longString, main, max, max, min, min, multiply, multiply, negate, negate, notifyReferences, pow, pow, remainder, remainder, rint, rint, round, round, sin, sin, sinDegrees, sinDegrees, sqrt, sqrt, subtract, subtract, tan, tan, tanDegrees, tanDegrees, unary
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface visad.Data
abs, abs, acos, acos, acosDegrees, acosDegrees, add, add, adjustSamplingError, asin, asin, asinDegrees, asinDegrees, atan, atan, atan2, atan2, atan2Degrees, atan2Degrees, atanDegrees, atanDegrees, binary, ceil, ceil, changeMathType, computeRanges, computeRanges, cos, cos, cosDegrees, cosDegrees, dataClone, divide, divide, exp, exp, floor, floor, getType, local, log, log, longString, max, max, min, min, multiply, multiply, negate, negate, pow, pow, remainder, remainder, rint, rint, round, round, sin, sin, sinDegrees, sinDegrees, sqrt, sqrt, subtract, subtract, tan, tan, tanDegrees, tanDegrees, unary
 

Constructor Detail

Text

public Text(TextType type)
     throws VisADException
construct a Text object with the missing value

Throws:
VisADException

Text

public Text(TextType type,
            java.lang.String value)
     throws VisADException
construct a Text object

Throws:
VisADException

Text

public Text(java.lang.String value)
construct a Text object with the generic TEXT type (TextType.Generic)

Method Detail

getValue

public java.lang.String getValue()

isMissing

public boolean isMissing()
Description copied from interface: Data
a method to tell whether data object has a missing value


binary

public Data binary(Data data,
                   int op,
                   int sampling_mode,
                   int error_mode)
            throws VisADException
Description copied from class: DataImpl
binary operations

Specified by:
binary in interface Data
Overrides:
binary in class DataImpl
Throws:
VisADException

unary

public Data unary(int op,
                  int sampling_mode,
                  int error_mode)
           throws VisADException
Description copied from class: DataImpl
unary operations

Specified by:
unary in interface Data
Overrides:
unary in class DataImpl
Throws:
VisADException

computeRanges

public DataShadow computeRanges(ShadowType type,
                                DataShadow shadow)
                         throws VisADException
Description copied from interface: Data
recursive version of computeRanges; would like 'default' visibility here, but must be declared 'public' because it is defined in the Data interface

Throws:
VisADException

toString

public java.lang.String toString()
Overrides:
toString in class DataImpl

longString

public java.lang.String longString(java.lang.String pre)
Description copied from class: DataImpl
generates a longer string than generated by toString, indented by pre (a string of blanks)

Specified by:
longString in interface Data
Overrides:
longString in class DataImpl

compareTo

public int compareTo(java.lang.Object object)
Compares this Text to another.

Parameters:
object - The other Text to compare against. It shall be a Text.
Returns:
A negative integer, zero, or a positive integer depending on whether this Text is considered less than, equal to, or greater than the other Text, respectively.

equals

public boolean equals(java.lang.Object obj)
Indicates if this Text is semantically identical to an object.

Specified by:
equals in interface ScalarIface
Specified by:
equals in class Scalar
Parameters:
obj - The object.
Returns:
true if and only if this Text is semantically identical to the object.