org.apache.uima.resourceSpecifier.factory
Interface DeploymentDescriptor

All Known Subinterfaces:
UimaASAggregateDeploymentDescriptor, UimaASPrimitiveDeploymentDescriptor
All Known Implementing Classes:
DeploymentDescriptorImpl, UimaASAggregateDeploymentDescriptorImpl, UimaASPrimitiveDeploymentDescriptorImpl

public interface DeploymentDescriptor

The Interface DeploymentDescriptor.


Method Summary
 String getBroker()
          Gets the broker.
 int getCasPoolSize()
          Gets the cas pool size.
 String getDescription()
          Gets the description.
 String getEndpoint()
          Gets the endpoint.
 int getInitialHeapSize()
          Gets the initial heap size.
 String getName()
          Gets the name.
 int getPrefetch()
          Gets the prefetch.
 String getProtocol()
           
 String getProvider()
           
 String getServiceAnalysisEngineDescriptor()
          Gets the service analysis engine descriptor.
 boolean isAsync()
          Checks if is async.
 void save(File file)
          Save.
 void setAsync(boolean async)
          Sets the async.
 void setBroker(String broker)
          Sets the broker.
 void setCasPoolSize(int casPoolSize)
          Sets the cas pool size.
 void setDescription(String description)
          Sets the description.
 void setEndoint(String endpoint)
          Sets the endoint.
 void setInitialHeapSize(int initialHeapSize)
          Sets the initial heap size.
 void setName(String name)
          Sets the name.
 void setPrefetch(int prefetch)
          Sets the prefetch.
 void setProtocol(String protocol)
           
 void setProvider(String provider)
           
 void setServiceAnalysisEngineDescriptor(String aeDescriptorPath)
          Sets the service analysis engine descriptor.
 String toXML()
          To xml.
 

Method Detail

setName

void setName(String name)
Sets the name.

Parameters:
name - the new name

getName

String getName()
Gets the name.

Returns:
the name

setAsync

void setAsync(boolean async)
Sets the async.

Parameters:
async - the new async

isAsync

boolean isAsync()
Checks if is async.

Returns:
true, if is async

setDescription

void setDescription(String description)
Sets the description.

Parameters:
description - the new description

getDescription

String getDescription()
Gets the description.

Returns:
the description

setServiceAnalysisEngineDescriptor

void setServiceAnalysisEngineDescriptor(String aeDescriptorPath)
Sets the service analysis engine descriptor.

Parameters:
aeDescriptorPath - the new service analysis engine descriptor

getServiceAnalysisEngineDescriptor

String getServiceAnalysisEngineDescriptor()
Gets the service analysis engine descriptor.

Returns:
the service analysis engine descriptor

setEndoint

void setEndoint(String endpoint)
Sets the endoint.

Parameters:
endpoint - the new endoint

getEndpoint

String getEndpoint()
Gets the endpoint.

Returns:
the endpoint

setBroker

void setBroker(String broker)
Sets the broker.

Parameters:
broker - the new broker

getBroker

String getBroker()
Gets the broker.

Returns:
the broker

setCasPoolSize

void setCasPoolSize(int casPoolSize)
Sets the cas pool size.

Parameters:
casPoolSize - the new cas pool size

getCasPoolSize

int getCasPoolSize()
Gets the cas pool size.

Returns:
the cas pool size

setInitialHeapSize

void setInitialHeapSize(int initialHeapSize)
Sets the initial heap size.

Parameters:
initialHeapSize - the new initial heap size

getInitialHeapSize

int getInitialHeapSize()
Gets the initial heap size.

Returns:
the initial heap size

setPrefetch

void setPrefetch(int prefetch)
Sets the prefetch.

Parameters:
prefetch - the new prefetch

getPrefetch

int getPrefetch()
Gets the prefetch.

Returns:
the prefetch

setProtocol

void setProtocol(String protocol)

getProtocol

String getProtocol()

setProvider

void setProvider(String provider)

getProvider

String getProvider()

toXML

String toXML()
To xml.

Returns:
the string

save

void save(File file)
          throws Exception
Save.

Parameters:
file - the file
Throws:
Exception - the exception


Copyright © 2006-2012 The Apache Software Foundation. All Rights Reserved.