org.gcube.textextraction
Class TextExtractionJobControllerResource

java.lang.Object
  extended by GCUBEWSResource
      extended by org.gcube.textextraction.TextExtractionJobControllerResource

public class TextExtractionJobControllerResource
extends GCUBEWSResource

A class containing stateful information regarding an OpenSearch adaptor.

Author:
Vassilis Verroios, NKUA, gerasimos.farantatos, NKUA

Field Summary
static java.lang.String RP_BATCHSIZE
           
static java.lang.String RP_DTS_INPUT_COLLECTION_ID
           
static java.lang.String RP_FTP_HOST
           
static java.lang.String RP_FTP_LOCATION_DIRECTORY
           
static java.lang.String RP_JOBS
           
static java.lang.String RP_NUMBER_OF_COMPLETED_JOBS
           
static java.lang.String RP_QUERY_TO_SUBMIT
           
static java.lang.String RP_REPOSITORY_ID
          The list of standard resource properties defined by every OpenSearch WS resource
static java.lang.String RP_REPOSITORY_NUMBER_OF_RECORDS
           
static java.lang.String RP_SERVLET_URI
           
static java.lang.String RP_STATUS
           
 
Constructor Summary
TextExtractionJobControllerResource()
          Empty constructor.
 
Method Summary
 CancelResponse cancel(Cancel cancel)
          Performs a query on the OpenSearch provider that is connected to this resource.
 int getBatchSize()
           
 java.lang.String getDTSInputCollectionID()
          Getter method for the DescriptionDocument Resource Property
 java.lang.String getFTPHost()
           
 java.lang.String getFTPLocationDirectory()
          Getter method for the DescriptionDocument Resource Property
 JobInfoType[] getJobs()
          Getter method for the CollectionID list Resource Property
 int getNumberOfCompletedJobs()
          Getter method for the DescriptionDocument Resource Property
 java.lang.String[] getPropertyNames()
          Retrieves the property names
 java.lang.String getQueryToSubmit()
          Getter method for the DescriptionDocument Resource Property
 java.lang.String getRepositoryID()
          Getter method for the AdaptorID Resource Property
 int getRepositoryNumberOfRecords()
          Getter method for the DescriptionDocument Resource Property
 GCUBEServiceContext getServiceContext()
           
 java.lang.String getServletURI()
          Getter method for the DescriptionDocument Resource Property
 java.lang.String getStatus()
          Getter method for the DescriptionDocument Resource Property
 boolean isInitializing()
          Returns the current initialization state of the resource
 void onResourceRemoval()
           
 void setBatchSize(int bs)
           
 void setDTSInputCollectionID(java.lang.String dtsInputCollectionID)
          Setter method for the DescriptionDocument Resource Property
 void setFTPHost(java.lang.String ftpHostAddress)
           
 void setFTPLocationDirectory(java.lang.String ftpLocationDirectory)
          Setter method for the DescriptionDocument Resource Property
 void setIsInitializing(boolean isInitializing)
          Specifies the current state of the resource (initializing or not)
 void setJobs(JobInfoType[] jobs)
           
 void setNumberOfCompletedJobs(int numberOfCompletedJobs)
          Setter method for the DescriptionDocument Resource Property
 void setQueryToSubmit(java.lang.String queryToSubmit)
          Setter method for the DescriptionDocument Resource Property
 void setRepositoryID(java.lang.String repositoryID)
          Setter method for the AdaptorID Resource Property
 void setRepositoryNumberOfRecords(int repositoryNumberOfRecords)
          Setter method for the DescriptionDocument Resource Property
 void setServletURI(java.lang.String servletURI)
          Setter method for the DescriptionDocument Resource Property
 void setStatus(java.lang.String status)
          Setter method for the DescriptionDocument Resource Property
 StartResponse start(Start start)
          Performs a query on the OpenSearch provider that is connected to this resource.
 void store()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RP_REPOSITORY_ID

public static final java.lang.String RP_REPOSITORY_ID
The list of standard resource properties defined by every OpenSearch WS resource

See Also:
Constant Field Values

RP_JOBS

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

RP_QUERY_TO_SUBMIT

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

RP_DTS_INPUT_COLLECTION_ID

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

RP_STATUS

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

RP_SERVLET_URI

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

RP_FTP_LOCATION_DIRECTORY

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

RP_REPOSITORY_NUMBER_OF_RECORDS

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

RP_NUMBER_OF_COMPLETED_JOBS

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

RP_FTP_HOST

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

RP_BATCHSIZE

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

TextExtractionJobControllerResource

public TextExtractionJobControllerResource()
Empty constructor. Initialization is done through the initialize(...) method.

Method Detail

getPropertyNames

public java.lang.String[] getPropertyNames()
Retrieves the property names

Returns:
An array containing the property names

isInitializing

public boolean isInitializing()
Returns the current initialization state of the resource

Returns:
true if the resource is currently initializing, false otherwise

setIsInitializing

public void setIsInitializing(boolean isInitializing)
Specifies the current state of the resource (initializing or not)

Parameters:
isInitializing - the initialization state to set

store

public void store()

getRepositoryID

public java.lang.String getRepositoryID()
Getter method for the AdaptorID Resource Property

Returns:
String the requested adaptorID

setRepositoryID

public void setRepositoryID(java.lang.String repositoryID)
Setter method for the AdaptorID Resource Property

Parameters:
collectorJobID - String the new AdaptorID

getJobs

public JobInfoType[] getJobs()
Getter method for the CollectionID list Resource Property

Returns:
String[] the requested CollectionIDs

setJobs

public void setJobs(JobInfoType[] jobs)
Parameters:
jobs -

getDTSInputCollectionID

public java.lang.String getDTSInputCollectionID()
Getter method for the DescriptionDocument Resource Property

Returns:
String the requested DescriptionDocumentURI

setDTSInputCollectionID

public void setDTSInputCollectionID(java.lang.String dtsInputCollectionID)
                             throws java.lang.Exception
Setter method for the DescriptionDocument Resource Property

Parameters:
descriptionDocumentURI - String the new DescriptionDocumentURI
Throws:
java.lang.Exception - In case of error

getFTPLocationDirectory

public java.lang.String getFTPLocationDirectory()
Getter method for the DescriptionDocument Resource Property

Returns:
String the requested DescriptionDocumentURI

getFTPHost

public java.lang.String getFTPHost()

getBatchSize

public int getBatchSize()

setFTPLocationDirectory

public void setFTPLocationDirectory(java.lang.String ftpLocationDirectory)
                             throws java.lang.Exception
Setter method for the DescriptionDocument Resource Property

Parameters:
descriptionDocumentURI - String the new DescriptionDocumentURI
Throws:
java.lang.Exception - In case of error

setBatchSize

public void setBatchSize(int bs)
                  throws java.lang.Exception
Throws:
java.lang.Exception

setFTPHost

public void setFTPHost(java.lang.String ftpHostAddress)
                throws java.lang.Exception
Throws:
java.lang.Exception

getRepositoryNumberOfRecords

public int getRepositoryNumberOfRecords()
Getter method for the DescriptionDocument Resource Property

Returns:
String the requested DescriptionDocumentURI

setRepositoryNumberOfRecords

public void setRepositoryNumberOfRecords(int repositoryNumberOfRecords)
                                  throws java.lang.Exception
Setter method for the DescriptionDocument Resource Property

Parameters:
descriptionDocumentURI - String the new DescriptionDocumentURI
Throws:
java.lang.Exception - In case of error

getNumberOfCompletedJobs

public int getNumberOfCompletedJobs()
Getter method for the DescriptionDocument Resource Property

Returns:
String the requested DescriptionDocumentURI

setNumberOfCompletedJobs

public void setNumberOfCompletedJobs(int numberOfCompletedJobs)
                              throws java.lang.Exception
Setter method for the DescriptionDocument Resource Property

Parameters:
descriptionDocumentURI - String the new DescriptionDocumentURI
Throws:
java.lang.Exception - In case of error

getQueryToSubmit

public java.lang.String getQueryToSubmit()
Getter method for the DescriptionDocument Resource Property

Returns:
String the requested DescriptionDocumentURI

setQueryToSubmit

public void setQueryToSubmit(java.lang.String queryToSubmit)
                      throws java.lang.Exception
Setter method for the DescriptionDocument Resource Property

Parameters:
descriptionDocumentURI - String the new DescriptionDocumentURI
Throws:
java.lang.Exception - In case of error

getServletURI

public java.lang.String getServletURI()
Getter method for the DescriptionDocument Resource Property

Returns:
String the requested DescriptionDocumentURI

setServletURI

public void setServletURI(java.lang.String servletURI)
                   throws java.lang.Exception
Setter method for the DescriptionDocument Resource Property

Parameters:
descriptionDocumentURI - String the new DescriptionDocumentURI
Throws:
java.lang.Exception - In case of error

getStatus

public java.lang.String getStatus()
Getter method for the DescriptionDocument Resource Property

Returns:
String the requested DescriptionDocumentURI

setStatus

public void setStatus(java.lang.String status)
               throws java.lang.Exception
Setter method for the DescriptionDocument Resource Property

Parameters:
descriptionDocumentURI - String the new DescriptionDocumentURI
Throws:
java.lang.Exception - In case of error

start

public StartResponse start(Start start)
                    throws java.rmi.RemoteException
Performs a query on the OpenSearch provider that is connected to this resource.

Parameters:
queryString - String - the query to be performed (using custom syntax @see )
Returns:
URI - representation of the EPR for a resultset service which holds the results of the query.
Throws:
java.rmi.RemoteException - In case of error
EnvironmentValidationException

cancel

public CancelResponse cancel(Cancel cancel)
                      throws java.rmi.RemoteException
Performs a query on the OpenSearch provider that is connected to this resource.

Parameters:
queryString - String - the query to be performed (using custom syntax @see )
Returns:
URI - representation of the EPR for a resultset service which holds the results of the query.
Throws:
java.rmi.RemoteException - In case of error

getServiceContext

public GCUBEServiceContext getServiceContext()

onResourceRemoval

public void onResourceRemoval()