DeploymentDescriptorImpl (Apache UIMA-AS Java SDK 2.8.1 User-Level API Documentation)

java.lang.Object
- org.apache.uima.resourceSpecifier.factory.impl.DeploymentDescriptorImpl

All Implemented Interfaces:

DeploymentDescriptor

Direct Known Subclasses:

UimaASAggregateDeploymentDescriptorImpl, UimaASPrimitiveDeploymentDescriptorImpl
```
public abstract class DeploymentDescriptorImpl
extends Object
implements DeploymentDescriptor
```
The Class DeploymentDescriptorImpl.

Field Summary

Fields
Modifier and Type Field and Description

protected UimaASDeploymentDescriptor deploymentDescriptor
The deployment descriptor.

Fields
Modifier and Type	Field and Description
`protected UimaASDeploymentDescriptor`	`deploymentDescriptor` The deployment descriptor.

Constructor Summary

Constructors
Modifier Constructor and Description

protected DeploymentDescriptorImpl(UimaASDeploymentDescriptor deploymentDescriptor)
Instantiates a new deployment descriptor impl.

Constructors
Modifier	Constructor and Description
`protected`	`DeploymentDescriptorImpl(UimaASDeploymentDescriptor deploymentDescriptor)` Instantiates a new deployment descriptor impl.

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getBroker()` Gets the broker.
`int`	`getCasPoolSize()` Gets the cas pool size.
`protected UimaASDeploymentDescriptor`	`getDeploymentDescriptor()`
`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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - deploymentDescriptor
```
protected UimaASDeploymentDescriptor deploymentDescriptor
```
    The deployment descriptor.
- Constructor Detail
  - DeploymentDescriptorImpl
```
protected DeploymentDescriptorImpl(UimaASDeploymentDescriptor deploymentDescriptor)
```
    Instantiates a new deployment descriptor impl.
    
    Parameters:
    deploymentDescriptor - the deployment descriptor
- Method Detail
  - getDeploymentDescriptor
```
protected UimaASDeploymentDescriptor getDeploymentDescriptor()
```
  - setName
```
public void setName(String name)
```
    Description copied from interface: DeploymentDescriptor
    
    Sets the name.
    
    Specified by:
    
    setName in interface DeploymentDescriptor
    
    Parameters:
    name - the new name
  - getName
```
public String getName()
```
    Description copied from interface: DeploymentDescriptor
    
    Gets the name.
    
    Specified by:
    
    getName in interface DeploymentDescriptor
    
    Returns:
    the name
  - setDescription
```
public void setDescription(String description)
```
    Description copied from interface: DeploymentDescriptor
    
    Sets the description.
    
    Specified by:
    
    setDescription in interface DeploymentDescriptor
    
    Parameters:
    description - the new description
  - getDescription
```
public String getDescription()
```
    Description copied from interface: DeploymentDescriptor
    
    Gets the description.
    
    Specified by:
    
    getDescription in interface DeploymentDescriptor
    
    Returns:
    the description
  - setServiceAnalysisEngineDescriptor
```
public void setServiceAnalysisEngineDescriptor(String aeDescriptorPath)
```
    Description copied from interface: DeploymentDescriptor
    
    Sets the service analysis engine descriptor.
    
    Specified by:
    
    setServiceAnalysisEngineDescriptor in interface DeploymentDescriptor
    
    Parameters:
    aeDescriptorPath - the new service analysis engine descriptor
  - getServiceAnalysisEngineDescriptor
```
public String getServiceAnalysisEngineDescriptor()
```
    Description copied from interface: DeploymentDescriptor
    
    Gets the service analysis engine descriptor.
    
    Specified by:
    
    getServiceAnalysisEngineDescriptor in interface DeploymentDescriptor
    
    Returns:
    the service analysis engine descriptor
  - setEndoint
```
public void setEndoint(String endpoint)
```
    Description copied from interface: DeploymentDescriptor
    
    Sets the endoint.
    
    Specified by:
    
    setEndoint in interface DeploymentDescriptor
    
    Parameters:
    endpoint - the new endoint
  - getEndpoint
```
public String getEndpoint()
```
    Description copied from interface: DeploymentDescriptor
    
    Gets the endpoint.
    
    Specified by:
    
    getEndpoint in interface DeploymentDescriptor
    
    Returns:
    the endpoint
  - setBroker
```
public void setBroker(String broker)
```
    Description copied from interface: DeploymentDescriptor
    
    Sets the broker.
    
    Specified by:
    
    setBroker in interface DeploymentDescriptor
    
    Parameters:
    broker - the new broker
  - getBroker
```
public String getBroker()
```
    Description copied from interface: DeploymentDescriptor
    
    Gets the broker.
    
    Specified by:
    
    getBroker in interface DeploymentDescriptor
    
    Returns:
    the broker
  - setPrefetch
```
public void setPrefetch(int prefetch)
```
    Description copied from interface: DeploymentDescriptor
    
    Sets the prefetch.
    
    Specified by:
    
    setPrefetch in interface DeploymentDescriptor
    
    Parameters:
    prefetch - the new prefetch
  - getPrefetch
```
public int getPrefetch()
```
    Description copied from interface: DeploymentDescriptor
    
    Gets the prefetch.
    
    Specified by:
    
    getPrefetch in interface DeploymentDescriptor
    
    Returns:
    the prefetch
  - setCasPoolSize
```
public void setCasPoolSize(int casPoolSize)
```
    Description copied from interface: DeploymentDescriptor
    
    Sets the cas pool size.
    
    Specified by:
    
    setCasPoolSize in interface DeploymentDescriptor
    
    Parameters:
    casPoolSize - the new cas pool size
  - getCasPoolSize
```
public int getCasPoolSize()
```
    Description copied from interface: DeploymentDescriptor
    
    Gets the cas pool size.
    
    Specified by:
    
    getCasPoolSize in interface DeploymentDescriptor
    
    Returns:
    the cas pool size
  - setInitialHeapSize
```
public void setInitialHeapSize(int initialHeapSize)
```
    Description copied from interface: DeploymentDescriptor
    
    Sets the initial heap size.
    
    Specified by:
    
    setInitialHeapSize in interface DeploymentDescriptor
    
    Parameters:
    initialHeapSize - the new initial heap size
  - getInitialHeapSize
```
public int getInitialHeapSize()
```
    Description copied from interface: DeploymentDescriptor
    
    Gets the initial heap size.
    
    Specified by:
    
    getInitialHeapSize in interface DeploymentDescriptor
    
    Returns:
    the initial heap size
  - toXML
```
public String toXML()
```
    Description copied from interface: DeploymentDescriptor
    
    To xml.
    
    Specified by:
    
    toXML in interface DeploymentDescriptor
    
    Returns:
    the string
  - save
```
public void save(File file)
          throws Exception
```
    Description copied from interface: DeploymentDescriptor
    
    Save.
    
    Specified by:
    
    save in interface DeploymentDescriptor
    
    Parameters:
    file - the file
    
    Throws:
    
    Exception - the exception
  - isAsync
```
public boolean isAsync()
```
    Description copied from interface: DeploymentDescriptor
    
    Checks if is async.
    
    Specified by:
    
    isAsync in interface DeploymentDescriptor
    
    Returns:
    true, if is async
  - setAsync
```
public void setAsync(boolean async)
```
    Description copied from interface: DeploymentDescriptor
    
    Sets the async.
    
    Specified by:
    
    setAsync in interface DeploymentDescriptor
    
    Parameters:
    async - the new async
  - setProtocol
```
public void setProtocol(String protocol)
```
    Specified by:
    
    setProtocol in interface DeploymentDescriptor
  - getProtocol
```
public String getProtocol()
```
    Specified by:
    
    getProtocol in interface DeploymentDescriptor
  - setProvider
```
public void setProvider(String provider)
```
    Specified by:
    
    setProvider in interface DeploymentDescriptor
  - getProvider
```
public String getProvider()
```
    Specified by:
    
    getProvider in interface DeploymentDescriptor

Class DeploymentDescriptorImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

deploymentDescriptor

Constructor Detail

DeploymentDescriptorImpl

Method Detail

getDeploymentDescriptor

setName

getName

setDescription

getDescription

setServiceAnalysisEngineDescriptor

getServiceAnalysisEngineDescriptor

setEndoint

getEndpoint

setBroker

getBroker

setPrefetch

getPrefetch

setCasPoolSize

getCasPoolSize

setInitialHeapSize

getInitialHeapSize

toXML

save

isAsync

setAsync

setProtocol

getProtocol

setProvider

getProvider