SofaMapping

All Superinterfaces:

java.lang.Cloneable, MetaDataObject, java.io.Serializable, XMLizable

All Known Implementing Classes:

SofaMapping_impl
```
public interface SofaMapping
extends MetaDataObject
```
Sofa Name mapping is required to connect the output Sofas from one component to the input Sofa of another component.
A SofaMapping object represents mapping of a Sofa name assigned by a component to a Sofa name assigned by an aggregate which could be either an aggregate AE or a CPE. This interface provides methods to set the attributes that define a mapping.
If the component Sofa Name is not set, it defaults to (CAS.NAME_DEFAULT_SOFA).

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.lang.String`	`getAggregateSofaName()`	Get the sofa name assigned by the aggregate.
`java.lang.String`	`getComponentKey()`	Gets the component key.
`java.lang.String`	`getComponentSofaName()`	Gets the sofa name assigned by the component.
`void`	`setAggregateSofaName(java.lang.String aAggregateSofaName)`	Set the sofa name assigned by the aggregate.
`void`	`setComponentKey(java.lang.String aComponentKey)`	Set the component key.
`void`	`setComponentSofaName(java.lang.String aComponentSofaName)`	Set the component assigned sofa name.

Methods inherited from interface org.apache.uima.resource.metadata.MetaDataObject
clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrl

Methods inherited from interface org.apache.uima.util.XMLizable
buildFromXMLElement, buildFromXMLElement, toXML, toXML, toXML, toXML

- Method Detail
  - getComponentKey
```
java.lang.String getComponentKey()
```
    Gets the component key. This identifies the component for which this mapping is defined.
    
    Returns:
    
    the key
  - setComponentKey
```
void setComponentKey(java.lang.String aComponentKey)
```
    Set the component key. This identifies the component for which this mapping is defined.
    
    Parameters:
    
    aComponentKey - the key
  - getComponentSofaName
```
java.lang.String getComponentSofaName()
```
    Gets the sofa name assigned by the component.
    
    Returns:
    
    the component's sofa name
  - setComponentSofaName
```
void setComponentSofaName(java.lang.String aComponentSofaName)
```
    Set the component assigned sofa name.
    
    Parameters:
    
    aComponentSofaName - the component's sofa name
  - getAggregateSofaName
```
java.lang.String getAggregateSofaName()
```
    Get the sofa name assigned by the aggregate.
    
    Returns:
    
    the aggregate's sofa name
  - setAggregateSofaName
```
void setAggregateSofaName(java.lang.String aAggregateSofaName)
```
    Set the sofa name assigned by the aggregate.
    
    Parameters:
    
    aAggregateSofaName - the aggregate's sofa name