org.esa.beam.framework.datamodel

Class ProductData.ASCII

java.lang.Object

org.esa.beam.framework.datamodel.ProductData

org.esa.beam.framework.datamodel.ProductData.Byte

org.esa.beam.framework.datamodel.ProductData.ASCII

All Implemented Interfaces:

Cloneable

Enclosing class:

ProductData

public static class ProductData.ASCII
extends ProductData.Byte

The ProductData.ASCII class is a ProductData.Byte specialisation representing textual values.

Internally, data is stored in an array of the type byte[].

Nested Class Summary

Nested classes/interfaces inherited from class org.esa.beam.framework.datamodel.ProductData

ProductData.ASCII, ProductData.Byte, ProductData.Double, ProductData.Float, ProductData.Int, ProductData.Short, ProductData.UByte, ProductData.UInt, ProductData.UShort, ProductData.UTC

Field Summary

Fields inherited from class org.esa.beam.framework.datamodel.ProductData.Byte

_array

Fields inherited from class org.esa.beam.framework.datamodel.ProductData

TYPE_ASCII, TYPE_FLOAT32, TYPE_FLOAT64, TYPE_INT16, TYPE_INT32, TYPE_INT8, TYPE_UINT16, TYPE_UINT32, TYPE_UINT8, TYPE_UNDEFINED, TYPE_UTC, TYPESTRING_ASCII, TYPESTRING_FLOAT32, TYPESTRING_FLOAT64, TYPESTRING_INT16, TYPESTRING_INT32, TYPESTRING_INT8, TYPESTRING_UINT16, TYPESTRING_UINT32, TYPESTRING_UINT8, TYPESTRING_UTC

Constructor Summary

Constructors

Constructor and Description
ProductData.ASCII(int length) Constructs a new ASCII value.
ProductData.ASCII(String data) Constructs a new ASCII value.

Method Summary

Methods

Modifier and Type	Method and Description
protected ProductData	createDeepClone() Retuns a "deep" copy of this product data.
String	getElemString() Returns a textual representation of this value's value.
String	getElemStringAt(int index) Returns a textual representation of this product data.
String	getTypeString() Returns this value's data type String.
void	setElems(Object data) Sets the data of this value.

Methods inherited from class org.esa.beam.framework.datamodel.ProductData.Byte

clone, dispose, getArray, getElemDoubleAt, getElemFloatAt, getElemIntAt, getElems, getElemUIntAt, getNumElems, readFrom, setElemDoubleAt, setElemFloatAt, setElemIntAt, setElemUIntAt, writeTo

Methods inherited from class org.esa.beam.framework.datamodel.ProductData

createInstance, createInstance, createInstance, createInstance, createInstance, createInstance, createInstance, createInstance, createInstance, createInstance, createUnsignedInstance, createUnsignedInstance, createUnsignedInstance, equalElems, equals, getElemBoolean, getElemBooleanAt, getElemDouble, getElemFloat, getElemInt, getElemSize, getElemSize, getElemUInt, getType, getType, getTypeString, hashCode, isFloatingPointType, isInt, isIntType, isScalar, isSigned, isUIntType, isUnsigned, readFrom, readFrom, readFrom, setElemBoolean, setElemBooleanAt, setElemDouble, setElemFloat, setElemInt, setElemString, setElemStringAt, setElemUInt, toString, writeTo, writeTo, writeTo

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ProductData.ASCII

public ProductData.ASCII(int length)

Constructs a new ASCII value.

Parameters:

length - the ASCII string length

ProductData.ASCII

public ProductData.ASCII(String data)

Constructs a new ASCII value.

Parameters:

data - the ASCII string data

Method Detail

getElemString

public String getElemString()

Returns a textual representation of this value's value. The text returned is a string created from the bytes array elements in this value interpreted as ASCII values.

Overrides:

getElemString in class ProductData

Returns:

a text representing this product data, never null

setElems

public void setElems(Object data)

Sets the data of this value. The data must be a string, an byte or an char array. Each has to have at least a length of one.

Overrides:

setElems in class ProductData.Byte

Parameters:

data - the data array

Throws:

IllegalArgumentException - if data is null or it is not an array of the required type or does the array length is less than one.

getElemStringAt

public String getElemStringAt(int index)

Returns a textual representation of this product data. The text returned is a string cretaed from the bytes array elements in this value interpreted as ASCII values.

Overrides:

getElemStringAt in class ProductData.Byte

Parameters:

index - the value index, must be >=0 and <getNumDataElems()

Returns:

a text representing this product data, never null

createDeepClone

protected ProductData createDeepClone()

Retuns a "deep" copy of this product data.

Overrides:

createDeepClone in class ProductData.Byte

Returns:

a copy of this product data

getTypeString

public String getTypeString()

Returns this value's data type String.

Overrides:

getTypeString in class ProductData