org.gcube.indexmanagement.geoindexmanagement
Class GeoIndexManagementResource

java.lang.Object
  extended by IndexManagementWSResource
      extended by org.gcube.indexmanagement.geoindexmanagement.GeoIndexManagementResource

public class GeoIndexManagementResource
extends IndexManagementWSResource

A class containing stateful information regarding one particular Geographical index, along with methods needed to initiate and manage such an index.

Version:
0.1

Field Summary
static java.lang.String RP_GEOGRAPHICAL_SYSTEM
           
static java.lang.String RP_NUMBER_OF_DECIMALS
           
static java.lang.String RP_UNIT_OF_MEASUREMENT
           
 
Constructor Summary
GeoIndexManagementResource()
           
 
Method Summary
 void addCollectionID(java.lang.String collectionID)
          Adds a collection id to the collectionID resource property
 java.lang.String getGeographicalSystem()
          Getter method for the GeographicalSystem Resource Property
 DeltaListManagementHandler getIndexManagerHandler()
          Gets this resources delta list handler instance.
 java.lang.Integer getNumberOfDecimals()
          Getter method for the NumberOfDecimals Resource Property
 java.lang.String getUnitOfMeasurement()
          Getter method for the UnitOfMeasurement Resource Property
 void initialise(java.lang.Object... args)
          This method is used to initialize the resource instance, and must be called before using the resource instance.
 boolean isDeltaValid(DeltaFileInfoType arg0)
           
 void onLoad(java.io.ObjectInputStream ois, boolean firstLoad)
           
 void onResourceRemoval()
           
 void onStore(java.io.ObjectOutputStream oos)
           
 void setGeographicalSystem(java.lang.String geographicalSystem)
          Setter method for the GeographicalSystem Resource Property
 void setNumberOfDecimals(java.lang.Integer numberOfDecimals)
          Setter method for the NumberOfDecimals Resource Property
 void setUnitOfMeasurement(java.lang.String unitOfMeasurement)
          Setter method for the UnitOfMeasurement Resource Property
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RP_GEOGRAPHICAL_SYSTEM

public static final java.lang.String RP_GEOGRAPHICAL_SYSTEM
See Also:
Constant Field Values

RP_UNIT_OF_MEASUREMENT

public static final java.lang.String RP_UNIT_OF_MEASUREMENT
See Also:
Constant Field Values

RP_NUMBER_OF_DECIMALS

public static final java.lang.String RP_NUMBER_OF_DECIMALS
See Also:
Constant Field Values
Constructor Detail

GeoIndexManagementResource

public GeoIndexManagementResource()
Method Detail

initialise

public void initialise(java.lang.Object... args)
                throws java.lang.Exception
This method is used to initialize the resource instance, and must be called before using the resource instance.

Parameters:
args[0] - key GCUBEWSResourceKey - the key of the resource
args[1] - indexID String - the ID of the index to create
args[2] - indexTypeID String - the ID of the IndexType of the index
args[3] - collectionID String[] - a list of IDs of the collections to be included in the index
args[4] - geographicalSystem String - the geographical system used for the Index (WGS_1984, none...)
args[5] - unitOfMeasurement String - the unit of measurement used in the Index (DD, DecimalDegrees, cm, CentiMeters...)
args[6] - numberOfDecimals Integer - the maximum number of decimals in the coordinates of objects (usually 4 for decimal degrees).
Throws:
java.lang.Exception
See Also:
org.diligentproject.indexservice.fulltextindexlookup.impl.FullTextIndexLookupResourceHome

onStore

public void onStore(java.io.ObjectOutputStream oos)
             throws java.lang.Exception
Throws:
java.lang.Exception

onLoad

public void onLoad(java.io.ObjectInputStream ois,
                   boolean firstLoad)
            throws java.lang.Exception
Throws:
java.lang.Exception

getGeographicalSystem

public java.lang.String getGeographicalSystem()
Getter method for the GeographicalSystem Resource Property

Returns:
String the requested GeographicalSystem identifier

getUnitOfMeasurement

public java.lang.String getUnitOfMeasurement()
Getter method for the UnitOfMeasurement Resource Property

Returns:
String the requested UnitOfMeasurement

getNumberOfDecimals

public java.lang.Integer getNumberOfDecimals()
Getter method for the NumberOfDecimals Resource Property

Returns:
Integer the requested NumberOfDecimals value

addCollectionID

public void addCollectionID(java.lang.String collectionID)
Adds a collection id to the collectionID resource property

Parameters:
collectionID - String -the ID to be added

setGeographicalSystem

public void setGeographicalSystem(java.lang.String geographicalSystem)
Setter method for the GeographicalSystem Resource Property

Parameters:
indexID - String the new GeographicalSystem identifier

setUnitOfMeasurement

public void setUnitOfMeasurement(java.lang.String unitOfMeasurement)
Setter method for the UnitOfMeasurement Resource Property

Parameters:
indexID - String the new UnitOfMeasurement

setNumberOfDecimals

public void setNumberOfDecimals(java.lang.Integer numberOfDecimals)
Setter method for the NumberOfDecimals Resource Property

Parameters:
numberOfDecimals - Integer the new NumberOfDecimals

getIndexManagerHandler

public DeltaListManagementHandler getIndexManagerHandler()
Gets this resources delta list handler instance. Required by the DeltaListManager interface.

Returns:
DeltaListManagementHandler the requested DeltaListManagementHandler
See Also:
org.diligentproject.indexservice.storagehandling.DeltaListManager

onResourceRemoval

public void onResourceRemoval()

isDeltaValid

public boolean isDeltaValid(DeltaFileInfoType arg0)
                     throws IndexException
Throws:
IndexException