it.geosolutions.imageio.gdalframework
Class GDALCreateOption

Object
  extended by GDALCreateOption

public class GDALCreateOption
extends Object

Several GDAL format drivers allow to specify a set of options during the creation of a file. GDALCreateOption class allows to represent these creation options (properties as its name, its value,...) and it also provides a set of methods to perform validity checks when users specify the values for a create option.

Author:
Daniele Romagnoli, GeoSolutions, Simone Giannecchini, GeoSolutions

Field Summary
static int TYPE_CHAR
          Tag for Char Type
static int TYPE_FLOAT
          Tag for Floating Point Type
static int TYPE_INT
          Tag for Integer Type
static int TYPE_NONE
          Tag for Create options without a value
static int TYPE_STRING
          Tag for String Type
static int VALIDITYCHECKTYPE_COMBINATIONOF
          Accepted values are a combination of values belonging a set of predefined ones
static int VALIDITYCHECKTYPE_NONE
          Accepted values are anything
static int VALIDITYCHECKTYPE_ONEOF
          Accepted value is one of a set of predefined values
static int VALIDITYCHECKTYPE_STRING_SYNTAX
          Accepted values are strings which need to respect a predefined syntax
static int VALIDITYCHECKTYPE_VALUE
          Accepted value is a single one
static int VALIDITYCHECKTYPE_VALUE_BELONGINGRANGE_EXTREMESEXCLUDED
          Accepted values are contained in a range, having the extremes excluded.
static int VALIDITYCHECKTYPE_VALUE_BELONGINGRANGE_EXTREMESINCLUDED
          Accepted values are contained in a range, having the extremes included
static int VALIDITYCHECKTYPE_VALUE_BELONGINGRANGE_LEFTEXCLUDED
          Accepted values are contained in a range, having the left extreme excluded.
static int VALIDITYCHECKTYPE_VALUE_BELONGINGRANGE_RIGHTEXCLUDED
          Accepted values are contained in a range, having the right extreme excluded.
static int VALIDITYCHECKTYPE_VALUE_GREATERTHAN
          Accepted values are greater than a predefined one
static int VALIDITYCHECKTYPE_VALUE_GREATERTHANOREQUALTO
          Accepted values are greater than or equal to a predefined one
static int VALIDITYCHECKTYPE_VALUE_LESSTHAN
          Accepted values are less than a predefined one
static int VALIDITYCHECKTYPE_VALUE_LESSTHANOREQUALTO
          Accepted values are less than or equal to a predefined one
static int VALIDITYCHECKTYPE_VALUE_MULTIPLEOF
          Accepted values are multiple of a predefined one
static int VALIDITYCHECKTYPE_VALUE_POWEROF
          Accepted values are power of a predefined one
 
Constructor Summary
GDALCreateOption(String optionName, int validityCheckType, String[] validityValues, int representedValueType)
          Constructor for a GDALCreateOption.
 
Method Summary
 String getDefaultValue()
          returns the default value of the create option.
 String getOptionName()
          returns the name of the create option.
 int getRepresentedValueType()
          return the type of the represented value
 int getValidityCheckType()
          returns the validity check type for the create option.
 String[] getValidityValues()
          returns the array containing the validity values for the create option.
 String getValue()
          returns the set value of the create option.
 boolean isSet()
          returns true if the create option has been set.
 void setDefaultValue(String defaultValue)
          set the default value of the create option.
 void setOptionName(String optionName)
          set the name of the create option.
 void setRepresentedValueType(int representedValueType)
          set the type of the represented value
 void setValidityCheckType(int validityType)
          set the validity check type for the create option.
 void setValidityValues(String[] validityValues)
          set the array containing the validity values for the create option.
 void setValue(String value)
          Set the specified value for the create option.
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TYPE_INT

public static final int TYPE_INT
Tag for Integer Type

See Also:
Constant Field Values

TYPE_FLOAT

public static final int TYPE_FLOAT
Tag for Floating Point Type

See Also:
Constant Field Values

TYPE_NONE

public static final int TYPE_NONE
Tag for Create options without a value

See Also:
Constant Field Values

TYPE_CHAR

public static final int TYPE_CHAR
Tag for Char Type

See Also:
Constant Field Values

TYPE_STRING

public static final int TYPE_STRING
Tag for String Type

See Also:
Constant Field Values

VALIDITYCHECKTYPE_VALUE

public static final int VALIDITYCHECKTYPE_VALUE
Accepted value is a single one

See Also:
Constant Field Values

VALIDITYCHECKTYPE_ONEOF

public static final int VALIDITYCHECKTYPE_ONEOF
Accepted value is one of a set of predefined values

See Also:
Constant Field Values

VALIDITYCHECKTYPE_COMBINATIONOF

public static final int VALIDITYCHECKTYPE_COMBINATIONOF
Accepted values are a combination of values belonging a set of predefined ones

See Also:
Constant Field Values

VALIDITYCHECKTYPE_VALUE_BELONGINGRANGE_EXTREMESINCLUDED

public static final int VALIDITYCHECKTYPE_VALUE_BELONGINGRANGE_EXTREMESINCLUDED
Accepted values are contained in a range, having the extremes included

See Also:
Constant Field Values

VALIDITYCHECKTYPE_VALUE_BELONGINGRANGE_LEFTEXCLUDED

public static final int VALIDITYCHECKTYPE_VALUE_BELONGINGRANGE_LEFTEXCLUDED
Accepted values are contained in a range, having the left extreme excluded.

See Also:
Constant Field Values

VALIDITYCHECKTYPE_VALUE_BELONGINGRANGE_RIGHTEXCLUDED

public static final int VALIDITYCHECKTYPE_VALUE_BELONGINGRANGE_RIGHTEXCLUDED
Accepted values are contained in a range, having the right extreme excluded.

See Also:
Constant Field Values

VALIDITYCHECKTYPE_VALUE_BELONGINGRANGE_EXTREMESEXCLUDED

public static final int VALIDITYCHECKTYPE_VALUE_BELONGINGRANGE_EXTREMESEXCLUDED
Accepted values are contained in a range, having the extremes excluded.

See Also:
Constant Field Values

VALIDITYCHECKTYPE_VALUE_LESSTHAN

public static final int VALIDITYCHECKTYPE_VALUE_LESSTHAN
Accepted values are less than a predefined one

See Also:
Constant Field Values

VALIDITYCHECKTYPE_VALUE_LESSTHANOREQUALTO

public static final int VALIDITYCHECKTYPE_VALUE_LESSTHANOREQUALTO
Accepted values are less than or equal to a predefined one

See Also:
Constant Field Values

VALIDITYCHECKTYPE_VALUE_GREATERTHANOREQUALTO

public static final int VALIDITYCHECKTYPE_VALUE_GREATERTHANOREQUALTO
Accepted values are greater than or equal to a predefined one

See Also:
Constant Field Values

VALIDITYCHECKTYPE_VALUE_GREATERTHAN

public static final int VALIDITYCHECKTYPE_VALUE_GREATERTHAN
Accepted values are greater than a predefined one

See Also:
Constant Field Values

VALIDITYCHECKTYPE_VALUE_MULTIPLEOF

public static final int VALIDITYCHECKTYPE_VALUE_MULTIPLEOF
Accepted values are multiple of a predefined one

See Also:
Constant Field Values

VALIDITYCHECKTYPE_VALUE_POWEROF

public static final int VALIDITYCHECKTYPE_VALUE_POWEROF
Accepted values are power of a predefined one

See Also:
Constant Field Values

VALIDITYCHECKTYPE_STRING_SYNTAX

public static final int VALIDITYCHECKTYPE_STRING_SYNTAX
Accepted values are strings which need to respect a predefined syntax

See Also:
Constant Field Values

VALIDITYCHECKTYPE_NONE

public static final int VALIDITYCHECKTYPE_NONE
Accepted values are anything

See Also:
Constant Field Values
Constructor Detail

GDALCreateOption

public GDALCreateOption(String optionName,
                        int validityCheckType,
                        String[] validityValues,
                        int representedValueType)
Constructor for a GDALCreateOption.

Parameters:
optionName - The name of the create option
validityCheckType - The validityCheckType for the create option (see supported validity types)
validityValues - The array of validity values for the create option.
representedValueType - The type of value the create option is representing.
Method Detail

getDefaultValue

public String getDefaultValue()
returns the default value of the create option.

Returns:
the default value of the create option.

setDefaultValue

public void setDefaultValue(String defaultValue)
set the default value of the create option.


getOptionName

public String getOptionName()
returns the name of the create option.

Returns:
the name of the create option.

setOptionName

public void setOptionName(String optionName)
set the name of the create option.


isSet

public boolean isSet()
returns true if the create option has been set.

Returns:
true if the create option has been set.

getValidityCheckType

public int getValidityCheckType()
returns the validity check type for the create option.

Returns:
returns the validity check type for the create option.

setValidityCheckType

public void setValidityCheckType(int validityType)
set the validity check type for the create option.


getValidityValues

public String[] getValidityValues()
returns the array containing the validity values for the create option.

Returns:
returns the array containing the validity values for this create option.

setValidityValues

public void setValidityValues(String[] validityValues)
set the array containing the validity values for the create option.


getValue

public String getValue()
returns the set value of the create option.

Returns:
the set value of the create option.

setValue

public void setValue(String value)
Set the specified value for the create option.

Parameters:
value - the value to set for the create option.

getRepresentedValueType

public int getRepresentedValueType()
return the type of the represented value

Returns:
the type of the represented value

setRepresentedValueType

public void setRepresentedValueType(int representedValueType)
set the type of the represented value



Copyright © 2006-2010 GeoSolutions. All Rights Reserved.