org.deegree_impl.model.cv
Class CV_SampleDimension_Impl

java.lang.Object
  org.deegree_impl.model.cv.CV_SampleDimension_Impl

All Implemented Interfaces:

CV_SampleDimension, java.rmi.Remote, java.io.Serializable

public class CV_SampleDimension_Impl

extends java.lang.Object

implements CV_SampleDimension, java.io.Serializable

Contains information for an individual sample dimension of coverage. This interface is applicable to any coverage type. For grid coverages, the sample dimension refers to an individual band.

Since:

1.00

Version:

1.00

See Also:

Serialized Form

Field Summary

private java.lang.String[]	categoryNames
private CV_ColorInterpretation	colorInterpretation
private int[][]	colorPalette
private java.lang.String	description
private double	maximumValue
private java.util.HashMap	metadata
private double	minimumValue
private double[]	noData
private int	offset
private CV_PaletteInterpretation	paletteInterpretation
private CV_SampleDimensionType	sampleDimensionType
private double	scale
private CS_Unit	units

Constructor Summary

CV_SampleDimension_Impl(java.lang.String[] categoryNames, java.lang.String description, double minimumValue, double maximumValue, GC_Parameter[] metadata, double[] noData, int offset, int[][] colorPalette, double scale, CS_Unit units, CV_ColorInterpretation colorInterpretation, CV_PaletteInterpretation paletteInterpretation, CV_SampleDimensionType sampleDimensionType)

Method Summary

java.lang.String[]	getCategoryNames() Sequence of category names for the values contained in a sample dimension.
CV_ColorInterpretation	getColorInterpretation() Color interpretation of the sample dimension.
java.lang.String	getDescription() Sample dimension title or description.
double	getMaximumValue() The maximum value occurring in the sample dimension.
java.lang.String[]	getMetaDataNames() The list of metadata keywords for a sample dimension.
java.lang.String	getMetadataValue(java.lang.String name) Retrieve the metadata value for a given metadata name.
double	getMinimumValue() The minimum value occurring in the sample dimension.
double[]	getNoDataValue() Values to indicate no data values for the sample dimension.
double	getOffset() Offset is the value to add to grid values for this sample dimension.
int[][]	getPalette() Color palette associated with the sample dimension.
CV_PaletteInterpretation	getPaletteInterpretation() Indicates the type of color palette entry for sample dimensions which have a palette.
CV_SampleDimensionType	getSampleDimensionType() A code value indicating grid value data type.
double	getScale() Scale is the value which is multiplied to grid values for this sample dimension.
CS_Unit	getUnits() The unit information for this sample dimension.

Methods inherited from class java.lang.Object

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

Field Detail

colorInterpretation

private CV_ColorInterpretation colorInterpretation

categoryNames

private java.lang.String[] categoryNames

description

private java.lang.String description

maximumValue

private double maximumValue

minimumValue

private double minimumValue

metadata

private java.util.HashMap metadata

noData

private double[] noData

offset

private int offset

colorPalette

private int[][] colorPalette

paletteInterpretation

private CV_PaletteInterpretation paletteInterpretation

sampleDimensionType

private CV_SampleDimensionType sampleDimensionType

scale

private double scale

units

private CS_Unit units

Constructor Detail

CV_SampleDimension_Impl

public CV_SampleDimension_Impl(java.lang.String[] categoryNames,
                               java.lang.String description,
                               double minimumValue,
                               double maximumValue,
                               GC_Parameter[] metadata,
                               double[] noData,
                               int offset,
                               int[][] colorPalette,
                               double scale,
                               CS_Unit units,
                               CV_ColorInterpretation colorInterpretation,
                               CV_PaletteInterpretation paletteInterpretation,
                               CV_SampleDimensionType sampleDimensionType)

Method Detail

getCategoryNames

public java.lang.String[] getCategoryNames()
                                    throws java.rmi.RemoteException

Sequence of category names for the values contained in a sample dimension. This allows for names to be assigned to numerical values. The first entry in the sequence relates to a cell value of zero. For grid coverages, category names are only valid for a classified grid data. For example:

• 0 Background
• 1 Water
• 2 Forest
• 3 Urban

Note: If no category names exist, an empty sequence is returned.

Specified by:

getCategoryNames in interface CV_SampleDimension

Returns:

the sequence of category names for the values contained in a sample dimension.

Throws:

java.rmi.RemoteException - if a remote method call failed.

getColorInterpretation

public CV_ColorInterpretation getColorInterpretation()
                                              throws java.rmi.RemoteException

Color interpretation of the sample dimension. A sample dimension can be an index into a color palette or be a color model component. If the sample dimension is not assigned a color interpretation the value is CV_Undefined.

Specified by:

getColorInterpretation in interface CV_SampleDimension

Returns:

the color interpretation of the sample dimension.

Throws:

java.rmi.RemoteException - if a remote method call failed.

getDescription

public java.lang.String getDescription()
                                throws java.rmi.RemoteException

Sample dimension title or description. This string may be null or empty if no description is present.

Specified by:

getDescription in interface CV_SampleDimension

Returns:

the sample dimension title or description.

Throws:

java.rmi.RemoteException - if a remote method call failed.

getMaximumValue

public double getMaximumValue()
                       throws java.rmi.RemoteException

The maximum value occurring in the sample dimension. If this value is not available, this value can be determined from the GP_GridAnalysis.getMaxValue(int) operation. This value can be empty if this value is not provided by the implementation.

Specified by:

getMaximumValue in interface CV_SampleDimension

Returns:

the maximum value occurring in the sample dimension.

Throws:

java.rmi.RemoteException - if a remote method call failed.

getMetaDataNames

public java.lang.String[] getMetaDataNames()
                                    throws java.rmi.RemoteException

The list of metadata keywords for a sample dimension. If no metadata is available, the sequence will be empty.

Specified by:

getMetaDataNames in interface CV_SampleDimension

Returns:

the list of metadata keywords for a sample dimension.

Throws:

java.rmi.RemoteException - if a remote method call failed.

getMetadataValue

public java.lang.String getMetadataValue(java.lang.String name)
                                  throws java.rmi.RemoteException

Retrieve the metadata value for a given metadata name.

Specified by:

getMetadataValue in interface CV_SampleDimension

Parameters:

name - Metadata keyword for which to retrieve metadata.

Returns:

the metadata value for a given metadata name.

Throws:

java.rmi.RemoteException - if a remote method call failed.

getMinimumValue

public double getMinimumValue()
                       throws java.rmi.RemoteException

The minimum value occurring in the sample dimension. If this value is not available, this value can be determined from the GP_GridAnalysis.getMinValue(int) operation. This value can be empty if this value is not provided by the implementation.

Specified by:

getMinimumValue in interface CV_SampleDimension

Returns:

the minimum value occurring in the sample dimension.

Throws:

java.rmi.RemoteException - if a remote method call failed.

getNoDataValue

public double[] getNoDataValue()
                        throws java.rmi.RemoteException

Values to indicate no data values for the sample dimension. For low precision sample dimensions, this will often be no data values.

Specified by:

getNoDataValue in interface CV_SampleDimension

Returns:

the values to indicate no data values for the sample dimension.

Throws:

java.rmi.RemoteException - if a remote method call failed.

getOffset

public double getOffset()
                 throws java.rmi.RemoteException

Offset is the value to add to grid values for this sample dimension. This attribute is typically used when the sample dimension represents elevation data. The default for this value is 0.

Specified by:

getOffset in interface CV_SampleDimension

Returns:

the offset is the value to add to grid values for this sample dimension.

Throws:

java.rmi.RemoteException - if a remote method call failed.

getPalette

public int[][] getPalette()
                   throws java.rmi.RemoteException

Color palette associated with the sample dimension. A color palette can have any number of colors. See palette interpretation for meaning of the palette entries. If the grid coverage has no color palette, an empty sequence will be returned.

Specified by:

getPalette in interface CV_SampleDimension

Returns:

the color palette associated with the sample dimension.

Throws:

java.rmi.RemoteException - if a remote method call failed.

getPaletteInterpretation

public CV_PaletteInterpretation getPaletteInterpretation()
                                                  throws java.rmi.RemoteException

Indicates the type of color palette entry for sample dimensions which have a palette. If a sample dimension has a palette, the color interpretation must be CV_GrayIndex or CV_PaletteIndex. A palette entry type can be Gray, RGB, CMYK or HLS.

Specified by:

getPaletteInterpretation in interface CV_SampleDimension

Returns:

the type of color palette entry for sample dimensions which have a palette.

Throws:

java.rmi.RemoteException - if a remote method call failed.

getSampleDimensionType

public CV_SampleDimensionType getSampleDimensionType()
                                              throws java.rmi.RemoteException

A code value indicating grid value data type. This will also indicate the number of bits for the data type.

Specified by:

getSampleDimensionType in interface CV_SampleDimension

Returns:

a code value indicating grid value data type.

Throws:

java.rmi.RemoteException - if a remote method call failed.

getScale

public double getScale()
                throws java.rmi.RemoteException

Scale is the value which is multiplied to grid values for this sample dimension. This attribute is typically used when the sample dimension represents elevation data. The default for this value is 1.

Specified by:

getScale in interface CV_SampleDimension

Returns:

the scale.

Throws:

java.rmi.RemoteException - if a remote method call failed.

getUnits

public CS_Unit getUnits()
                 throws java.rmi.RemoteException

The unit information for this sample dimension. This interface typically is provided with grid coverages which represent digital elevation data. This value will be null if no unit information is available.

Specified by:

getUnits in interface CV_SampleDimension

Returns:

the unit information for this sample dimension.

Throws:

java.rmi.RemoteException - if a remote method call failed.