org.gcube.indexmanagement.geoindexmanagement
Class GeoIndexManagementService

java.lang.Object
  extended by org.gcube.indexmanagement.geoindexmanagement.GeoIndexManagementService

public class GeoIndexManagementService
extends java.lang.Object

The GeoManagementService implements functionality needed to initiate and manage a Geographical index. There is only one GeoIndexManagementService instance per Geographical index, and a service instance can be seen as a logical representation of the index it initiates and manages. Any number of GeoIndexUpdaterService instances and GeoIndexLookupService instances can be connected to a single GeoIndexManagementService instance.

Version:
0.1

Constructor Summary
GeoIndexManagementService()
          Constructor
 
Method Summary
 VOID addCollectionID(java.lang.String collectionID)
          Add a collectionID to the Geo Index
 VOID addFields(StringArray fields)
          Adds a String field to the Fields resource property
 GetIndexInformationResponse getIndexInformation(VOID request)
          Retrieves a set of important characteristics for a FullTextIndexManagement WS resource
 java.lang.String getIndexTypeName(VOID empty)
          Gets the IndexTypeID of a GeotIndexManagement WS resource
 VOID setIndexTypeName(java.lang.String indexTypeID)
          Sets the IndexType of a GeoIndexManagement WS resource
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GeoIndexManagementService

public GeoIndexManagementService()
Constructor

Method Detail

getIndexInformation

public GetIndexInformationResponse getIndexInformation(VOID request)
                                                throws GCUBEFault
Retrieves a set of important characteristics for a FullTextIndexManagement WS resource

Parameters:
empty - GetIndexInformation - empty instance
Returns:
GetIndexInformationResponse - an object containing the resource's Index ID, Collection ID, Index Format, Index Type ID, XML representation of the Index Type, GeographicalSystem, UnitOfMeasurement, and the NumberOfDecimals.
Throws:
GCUBEFault

setIndexTypeName

public VOID setIndexTypeName(java.lang.String indexTypeID)
                      throws GCUBEFault
Sets the IndexType of a GeoIndexManagement WS resource

Parameters:
indexTypeID - String - the new IndexTypeID
Returns:
SetIndexTypeResponse - empty instance
Throws:
GCUBEFault

getIndexTypeName

public java.lang.String getIndexTypeName(VOID empty)
                                  throws GCUBEFault
Gets the IndexTypeID of a GeotIndexManagement WS resource

Parameters:
empty - GetIndexType - empty instance
Returns:
String - the requested IndexTypeID
Throws:
GCUBEFault

addCollectionID

public VOID addCollectionID(java.lang.String collectionID)
                     throws GCUBEFault
Add a collectionID to the Geo Index

Parameters:
collectionID - String - the collection ID to be added
Throws:
GCUBEFault

addFields

public VOID addFields(StringArray fields)
               throws GCUBEFault
Adds a String field to the Fields resource property

Parameters:
fields - String[] -the fields to be added
Returns:
AddFieldsResponse - empty instance
Throws:
GCUBEFault