org.gvsig.tools.persistence

Interface PersistentState

All Known Subinterfaces:

PersistentStateServices

All Known Implementing Classes:

AbstractPersistentState

public interface PersistentState

Method Summary

Modifier and Type	Method and Description
void	derelativizeFiles(java.io.File rootFolder) Make absolutes all files, urls and uris that are in this state from the folder specified.
java.lang.Object	get(java.lang.String name) Gets an Object property.
java.lang.Object[]	getArray(java.lang.String name, java.lang.Class valueClass) Returns an array whose elements are of the class given.
boolean	getBoolean(java.lang.String name) Gets a boolean property.
boolean	getBoolean(java.lang.String name, boolean defaultValue)
boolean[]	getBooleanArray(java.lang.String name) Returns an array whose elements are of boolean basic type.
PersistentContext	getContext()
java.util.Date	getDate(java.lang.String name) Gets a Date property.
java.util.Date[]	getDateArray(java.lang.String name) Returns an array whose elements are of Date type.
DynStruct	getDefinition() Returns the struct definition associated to this state
double	getDouble(java.lang.String name) Gets a double property.
double	getDouble(java.lang.String name, double defaultValue)
double[]	getDoubleArray(java.lang.String name) Returns an array whose elements are of double basic type.
java.io.File	getFile(java.lang.String name)
float	getFloat(java.lang.String name) Gets a float property.
float	getFloat(java.lang.String name, float defaultValue)
float[]	getFloatArray(java.lang.String name) Returns an array whose elements are of float basic type.
int	getInt(java.lang.String name) Gets an int property.
int	getInt(java.lang.String name, int defaultValue)
int[]	getIntArray(java.lang.String name) Returns an array whose elements are of int basic type.
java.util.Iterator	getIterator(java.lang.String name) Gets an Iterator over properties of types List, Set or Map.
java.util.List	getList(java.lang.String name) Gets a List property.
long	getLong(java.lang.String name) Gets an long property.
long	getLong(java.lang.String name, long defaultValue)
long[]	getLongArray(java.lang.String name) Returns an array whose elements are of long basic type.
java.util.Map	getMap(java.lang.String name) Gets a Map property.
java.util.Iterator	getNames() Gets an iterator over the names of the properties contained in this PersistentState.
java.util.Set	getSet(java.lang.String name) Gets a Set property.
java.lang.String	getString(java.lang.String name) Gets a String property.
java.lang.String[]	getStringArray(java.lang.String name) Returns an array whose elements are of String type.
java.lang.String	getTheClassName() Gets the name of the java class corresponding to this persistent state
java.net.URI	getURI(java.lang.String name)
java.net.URL	getURL(java.lang.String name)
boolean	hasValue(java.lang.String name) Informs that a property is set or not.
boolean	isNull(java.lang.String name)
void	relativizeFiles(java.io.File rootFolder) Make relatives all files, urls and uris that are in this state from the folder specified.
void	set(java.lang.String name, boolean value) Sets a property of type boolean.
void	set(java.lang.String name, java.lang.Boolean value) Sets a property of type Boolean.
void	set(java.lang.String name, boolean[] value) Sets a property of type List with an array of boolean.
void	set(java.lang.String name, java.util.Date value) Sets a property of type Date.
void	set(java.lang.String name, java.util.Date[] value) Sets a property of type List with an array of Date.
void	set(java.lang.String name, double value) Sets a property of type double.
void	set(java.lang.String name, java.lang.Double value) Sets a property of type Double.
void	set(java.lang.String name, double[] value) Sets a property of type List with an array of double.
void	set(java.lang.String name, java.io.File value)
void	set(java.lang.String name, float value) Sets a property of type float.
void	set(java.lang.String name, java.lang.Float value) Sets a property of type Float.
void	set(java.lang.String name, float[] value) Sets a property of type List with an array of float.
void	set(java.lang.String name, int value) Sets a property of type int.
void	set(java.lang.String name, int[] value) Sets a property of type List with an array of int.
void	set(java.lang.String name, java.lang.Integer value) Sets a property of type Integer.
void	set(java.lang.String name, java.util.Iterator it) Sets a property of type List (like do set(String, List) ) filled with the values provided by a Iterator The items of the iteration must be persistence supported types instance.
void	set(java.lang.String name, java.util.List value) Sets a property of type List.
void	set(java.lang.String name, long value) Sets a property of type long.
void	set(java.lang.String name, java.lang.Long value) Sets a property of type Long.
void	set(java.lang.String name, long[] value) Sets a property of type List with an array of long.
void	set(java.lang.String name, java.util.Map value) Sets a property of type Map.
void	set(java.lang.String name, java.lang.Object value) Sets a property.
void	set(java.lang.String name, java.lang.Object[] value) Sets a property of type List with an array.
void	set(java.lang.String name, Persistent obj) Sets a property of type Persistent.
void	set(java.lang.String name, java.util.Set value) Sets a property of type Set.
void	set(java.lang.String name, java.lang.String value) Sets a property of type String.
void	set(java.lang.String name, java.lang.String[] value) Sets a property of type List with an array of String.
void	set(java.lang.String name, java.net.URI value)
void	set(java.lang.String name, java.net.URL value)
void	setNull(java.lang.String name)

Method Detail

getTheClassName

java.lang.String getTheClassName()

Gets the name of the java class corresponding to this persistent state

Returns:

The class name of the java class represented by this state

getDefinition

DynStruct getDefinition()

Returns the struct definition associated to this state

Returns:

the DynStruct definition of the state.

getContext

PersistentContext getContext()

getInt

int getInt(java.lang.String name)
    throws PersistenceException

Gets an int property.

Parameters:

name - The name of the property to get

Returns:

The int property associated to the provided name

Throws:

PersistenceException

getInt

int getInt(java.lang.String name,
           int defaultValue)
    throws PersistenceException

Throws:

PersistenceException

getLong

long getLong(java.lang.String name)
      throws PersistenceException

Gets an long property.

Parameters:

name - The name of the property to get

Returns:

The long property associated to the provided name

Throws:

PersistenceException

getLong

long getLong(java.lang.String name,
             long defaultValue)
      throws PersistenceException

Throws:

PersistenceException

getDate

java.util.Date getDate(java.lang.String name)
                throws PersistenceException

Gets a Date property.

Parameters:

name -

Returns:

The Date property associated to the provided name

Throws:

PersistenceException

getDouble

double getDouble(java.lang.String name)
          throws PersistenceException

Gets a double property.

Parameters:

name - The name of the property to get

Returns:

The double property associated to the provided name

Throws:

PersistenceException

getDouble

double getDouble(java.lang.String name,
                 double defaultValue)
          throws PersistenceException

Throws:

PersistenceException

getFloat

float getFloat(java.lang.String name)
        throws PersistenceException

Gets a float property.

Parameters:

name - The name of the property to get

Returns:

The float property associated to the provided name

Throws:

PersistenceException

getFloat

float getFloat(java.lang.String name,
               float defaultValue)
        throws PersistenceException

Throws:

PersistenceException

getBoolean

boolean getBoolean(java.lang.String name)
            throws PersistenceException

Gets a boolean property.

Parameters:

name - The name of the property to get

Returns:

The boolean property associated to the provided name

Throws:

PersistenceException

getBoolean

boolean getBoolean(java.lang.String name,
                   boolean defaultValue)
            throws PersistenceException

Throws:

PersistenceException

getString

java.lang.String getString(java.lang.String name)
                    throws PersistenceException

Gets a String property.

Parameters:

name - The name of the property to get

Returns:

The String property associated to the provided name

Throws:

PersistenceException

getList

java.util.List getList(java.lang.String name)
                throws PersistenceException

Gets a List property. Don't use the returned List as it is, as it may not work as you expect. Instead, choose you own implementation and do something like: List myAttribute = new ArrayList(state.getList("prop"))

Parameters:

name - The name of the property to get

Returns:

The List property value associated to the provided name

Throws:

PersistenceException - if there is an error getting the property value

getArray

java.lang.Object[] getArray(java.lang.String name,
                            java.lang.Class valueClass)
                     throws PersistenceException

Returns an array whose elements are of the class given. This is useful to be able to cast the returned Object[] to the real class. To be able to store and load a property as an array, the type of the property defined in the DynStruct must be List.

Ex: Color[] colors = (Color[])state.getArray("colors", Color.class);

Parameters:

name - The name of the property to get

valueClass - the class of the array elements

Returns:

the array of elements

Throws:

PersistenceException - if there is an error getting the property value

getBooleanArray

boolean[] getBooleanArray(java.lang.String name)
                   throws PersistenceException

Returns an array whose elements are of boolean basic type. To be able to store and load a property as an array, the type of the property defined in the DynStruct must be List.

Parameters:

name - The name of the property to get

Returns:

the array of elements

Throws:

PersistenceException - if there is an error getting the property value

getIntArray

int[] getIntArray(java.lang.String name)
           throws PersistenceException

Returns an array whose elements are of int basic type. To be able to store and load a property as an array, the type of the property defined in the DynStruct must be List.

Parameters:

name - The name of the property to get

Returns:

the array of elements

Throws:

PersistenceException - if there is an error getting the property value

getLongArray

long[] getLongArray(java.lang.String name)
             throws PersistenceException

Returns an array whose elements are of long basic type. To be able to store and load a property as an array, the type of the property defined in the DynStruct must be List.

Parameters:

name - The name of the property to get

Returns:

the array of elements

Throws:

PersistenceException - if there is an error getting the property value

getFloatArray

float[] getFloatArray(java.lang.String name)
               throws PersistenceException

Returns an array whose elements are of float basic type. To be able to store and load a property as an array, the type of the property defined in the DynStruct must be List.

Parameters:

name - The name of the property to get

Returns:

the array of elements

Throws:

PersistenceException - if there is an error getting the property value

getDoubleArray

double[] getDoubleArray(java.lang.String name)
                 throws PersistenceException

Returns an array whose elements are of double basic type. To be able to store and load a property as an array, the type of the property defined in the DynStruct must be List.

Parameters:

name - The name of the property to get

Returns:

the array of elements

Throws:

PersistenceException - if there is an error getting the property value

getDateArray

java.util.Date[] getDateArray(java.lang.String name)
                       throws PersistenceException

Returns an array whose elements are of Date type. To be able to store and load a property as an array, the type of the property defined in the DynStruct must be List.

Parameters:

name -

Returns:

Throws:

PersistenceException

getStringArray

java.lang.String[] getStringArray(java.lang.String name)
                           throws PersistenceException

Returns an array whose elements are of String type. To be able to store and load a property as an array, the type of the property defined in the DynStruct must be List.

Parameters:

name -

Returns:

Throws:

PersistenceException

getMap

java.util.Map getMap(java.lang.String name)
              throws PersistenceException

Gets a Map property. Don't use the returned Map as is, as it may not be a real usable Map implementation. Don't use the returned Map as it is, as it may not work as you expect. Instead, choose you own implementation and do something like: Map myAttribute = new HashMap(state.getSet("prop"))

Parameters:

name - The name of the property to get

Returns:

The Map property value associated to the provided name

Throws:

PersistenceException - if there is an error getting the property value

getSet

java.util.Set getSet(java.lang.String name)
              throws PersistenceException

Gets a Set property. Don't use the returned Set as it is, as it may not work as you expect. Instead, choose you own implementation and do something like: Set myAttribute = new HashSet(state.getSet("prop"))

Parameters:

name - The name of the property to get

Returns:

The Set property value associated to the provided name

Throws:

PersistenceException - if there is an error getting the property value

getURL

java.net.URL getURL(java.lang.String name)
             throws PersistenceException

Throws:

PersistenceException

getURI

java.net.URI getURI(java.lang.String name)
             throws PersistenceException

Throws:

PersistenceException

getFile

java.io.File getFile(java.lang.String name)
              throws PersistenceException

Throws:

PersistenceException

get

java.lang.Object get(java.lang.String name)
              throws PersistenceException

Gets an Object property.

Parameters:

name - The name of the property to get

Returns:

The Object property associated to the provided name

Throws:

PersistenceException

isNull

boolean isNull(java.lang.String name)

getIterator

java.util.Iterator getIterator(java.lang.String name)
                        throws PersistenceException

Gets an Iterator over properties of types List, Set or Map.

Parameters:

name - The name of the property to get

Returns:

The Iterator associated to the property value of provided name

Throws:

PersistenceException

set

void set(java.lang.String name,
         java.lang.String value)
  throws PersistenceException

Sets a property of type String.

Parameters:

name - The name of the property to store (must be a valid Java identifier)

value -

Throws:

PersistenceException

set

void set(java.lang.String name,
         java.io.File value)
  throws PersistenceException

Throws:

PersistenceException

set

void set(java.lang.String name,
         java.net.URL value)
  throws PersistenceException

Throws:

PersistenceException

set

void set(java.lang.String name,
         java.net.URI value)
  throws PersistenceException

Throws:

PersistenceException

set

void set(java.lang.String name,
         int value)
  throws PersistenceException

Sets a property of type int.

Parameters:

name - The name of the property to store (must be a valid Java identifier)

value -

Throws:

PersistenceException

set

void set(java.lang.String name,
         long value)
  throws PersistenceException

Sets a property of type long.

Parameters:

name - The name of the property to store (must be a valid Java identifier)

value -

Throws:

PersistenceException

set

void set(java.lang.String name,
         double value)
  throws PersistenceException

Sets a property of type double.

Parameters:

name - The name of the property to store (must be a valid Java identifier)

value -

Throws:

PersistenceException

set

void set(java.lang.String name,
         float value)
  throws PersistenceException

Sets a property of type float.

Parameters:

name - The name of the property to store (must be a valid Java identifier)

value -

Throws:

PersistenceException

set

void set(java.lang.String name,
         boolean value)
  throws PersistenceException

Sets a property of type boolean.

Parameters:

name - The name of the property to store (must be a valid Java identifier)

value -

Throws:

PersistenceException

set

void set(java.lang.String name,
         Persistent obj)
  throws PersistenceException

Sets a property of type Persistent.

Parameters:

name - The name of the property to store (must be a valid Java identifier)

obj - The Persistent object to be stored in the state.

Throws:

PersistenceException

set

void set(java.lang.String name,
         java.util.List value)
  throws PersistenceException

Sets a property of type List.

The items of the list must be persistence supported types instance.

get(String) return an read only List instance after #load(Reader)

Parameters:

name - The name of the property to store (must be a valid Java identifier)

value - The List object to be stored in the state.

Throws:

PersistenceException

set

void set(java.lang.String name,
         java.lang.Object[] value)
  throws PersistenceException

Sets a property of type List with an array. To be able to store and load a property as an array, the type of the property defined in the DynStruct must be List.

Parameters:

name - The name of the property to set

value - the value to set

Throws:

PersistenceException - if there is an error setting the property value

set

void set(java.lang.String name,
         int[] value)
  throws PersistenceException

Sets a property of type List with an array of int. To be able to store and load a property as an array, the type of the property defined in the DynStruct must be List.

Parameters:

name - The name of the property to set

value - the value to set

Throws:

PersistenceException - if there is an error setting the property value

set

void set(java.lang.String name,
         long[] value)
  throws PersistenceException

Sets a property of type List with an array of long. To be able to store and load a property as an array, the type of the property defined in the DynStruct must be List.

Parameters:

name - The name of the property to set

value - the value to set

Throws:

PersistenceException - if there is an error setting the property value

set

void set(java.lang.String name,
         float[] value)
  throws PersistenceException

Sets a property of type List with an array of float. To be able to store and load a property as an array, the type of the property defined in the DynStruct must be List.

Parameters:

name - The name of the property to set

value - the value to set

Throws:

PersistenceException - if there is an error setting the property value

set

void set(java.lang.String name,
         double[] value)
  throws PersistenceException

Sets a property of type List with an array of double. To be able to store and load a property as an array, the type of the property defined in the DynStruct must be List.

Parameters:

name - The name of the property to set

value - the value to set

Throws:

PersistenceException - if there is an error setting the property value

set

void set(java.lang.String name,
         java.util.Date[] value)
  throws PersistenceException

Sets a property of type List with an array of Date. To be able to store and load a property as an array, the type of the property defined in the DynStruct must be List.

Parameters:

name -

value - the Date array to set.

Throws:

PersistenceException

set

void set(java.lang.String name,
         java.lang.String[] value)
  throws PersistenceException

Sets a property of type List with an array of String. To be able to store and load a property as an array, the type of the property defined in the DynStruct must be List.

Parameters:

name -

value -

Throws:

PersistenceException

set

void set(java.lang.String name,
         boolean[] value)
  throws PersistenceException

Sets a property of type List with an array of boolean. To be able to store and load a property as an array, the type of the property defined in the DynStruct must be List.

Parameters:

name - The name of the property to set

value - the value to set

Throws:

PersistenceException - if there is an error setting the property value

set

void set(java.lang.String name,
         java.util.Set value)
  throws PersistenceException

Sets a property of type Set.

The items of the set must be persistence supported type instances.

get(String) return an read only Set instance after #load(Reader)

Parameters:

name - The name of the property to store (must be a valid Java identifier)

value -

Throws:

PersistenceException

set

void set(java.lang.String name,
         java.util.Map value)
  throws PersistenceException

Sets a property of type Map.

The values and keys of the map must be persistence supported type instances.

get(String) return an read only Map instance after #load(Reader)

Parameters:

name - The name of the property to store (must be a valid Java identifier)

value -

Throws:

PersistenceException

set

void set(java.lang.String name,
         java.lang.Boolean value)
  throws PersistenceException

Sets a property of type Boolean.

Parameters:

name - The name of the property to store (must be a valid Java identifier)

value -

Throws:

PersistenceException

set

void set(java.lang.String name,
         java.util.Date value)
  throws PersistenceException

Sets a property of type Date.

Parameters:

name - The name of the property to store (must be a valid Java identifier)

value -

Throws:

PersistenceException

set

void set(java.lang.String name,
         java.lang.Integer value)
  throws PersistenceException

Sets a property of type Integer.

Parameters:

name - The name of the property to store (must be a valid Java identifier)

value -

Throws:

PersistenceException

set

void set(java.lang.String name,
         java.lang.Long value)
  throws PersistenceException

Sets a property of type Long.

Parameters:

name - The name of the property to store (must be a valid Java identifier)

value -

Throws:

PersistenceException

set

void set(java.lang.String name,
         java.lang.Float value)
  throws PersistenceException

Sets a property of type Float.

Parameters:

name - The name of the property to store (must be a valid Java identifier)

value -

Throws:

PersistenceException

set

void set(java.lang.String name,
         java.lang.Double value)
  throws PersistenceException

Sets a property of type Double.

Parameters:

name - The name of the property to store (must be a valid Java identifier)

value -

Throws:

PersistenceException

set

void set(java.lang.String name,
         java.util.Iterator it)
  throws PersistenceException

Sets a property of type List (like do set(String, List) ) filled with the values provided by a Iterator

The items of the iteration must be persistence supported types instance.

Parameters:

name - The name of the property to store (must be a valid Java identifier)

it - The iterator to get values to store in the list property.

Throws:

PersistenceException

See Also:

#set(String, List)}

set

void set(java.lang.String name,
         java.lang.Object value)
  throws PersistenceException

Sets a property.

value must be a supported type or manager must have a PersistenceFactory that know how persist it.

Parameters:

name - The name of the property to store (must be a valid Java identifier)

value -

Throws:

PersistenceException

setNull

void setNull(java.lang.String name)
      throws PersistenceException

Throws:

PersistenceException

getNames

java.util.Iterator getNames()

Gets an iterator over the names of the properties contained in this PersistentState.

Returns:

An iterator which provides the name of all the properties contained in this state.

hasValue

boolean hasValue(java.lang.String name)

Informs that a property is set or not.

Parameters:

name -

Returns:

relativizeFiles

void relativizeFiles(java.io.File rootFolder)

Make relatives all files, urls and uris that are in this state from the folder specified.

Parameters:

rootFolder -

derelativizeFiles

void derelativizeFiles(java.io.File rootFolder)

Make absolutes all files, urls and uris that are in this state from the folder specified.

Parameters:

rootFolder -