## Uses of Interface
org.apache.uima.cas.SofaID

- Packages that use SofaID
  Package | Description
  --- | ---
  org.apache.uima | The main package for the Unstructured Information Management Middleware Architecture.
  org.apache.uima.analysis_engine.annotator | The Annotator Interfaces, along with supporting interfaces and exception classes.
  org.apache.uima.analysis_engine.impl |
  org.apache.uima.cas | Common Analysis System (CAS) Interfaces.
  org.apache.uima.cas.impl | Implementation and Low-Level API for the CAS Interfaces.
  org.apache.uima.impl | Contains reference implementations of the interfaces in `org.apache.uima`.
  org.apache.uima.jcas | Interfaces for accessing the JCAS.
  org.apache.uima.jcas.cas | JCAS model for built-in CAS types
  org.apache.uima.jcas.impl | Provides the classes that support the Java Cas Model (JCM).

- - ### Uses of SofaID in org.apache.uima

    Methods in org.apache.uima that return SofaID
    Modifier and Type | Method and Description
    --- | ---
    `SofaID[]` | UimaContext.`getSofaMappings()` Deprecated. As of v2.0, annotators no longer need to explicitly call this method. CAS views can now be obtained directly by the method `CAS.getView(String)`, and the framework will automatically do the necessary Sofa mappings.
    `SofaID` | UimaContext.`mapToSofaID(String aSofaName)` Deprecated. As of v2.0, annotators no longer need to explicitly call this method. CAS views can now be obtained directly by the method `CAS.getView(String)`, and the framework will automatically do the necessary Sofa mappings.

  - ### Uses of SofaID in org.apache.uima.analysis_engine.annotator

    Methods in org.apache.uima.analysis_engine.annotator that return SofaID
    Modifier and Type | Method and Description
    --- | ---
    `SofaID[]` | AnnotatorContext.`getSofaMappings()` Deprecated. As of v2.0, annotators no longer need to explicitly call this method. CAS views can now be obtained directly by the method `CAS.getView(String)`, and the framework will automatically do the necessary Sofa mappings.
    `SofaID` | AnnotatorContext.`mapToSofaID(String aSofaName)` Deprecated. As of v2.0, annotators no longer need to explicitly call this method. CAS views can now be obtained directly by the method `CAS.getView(String)`, and the framework will automatically do the necessary Sofa mappings.

  - ### Uses of SofaID in org.apache.uima.analysis_engine.impl

    Methods in org.apache.uima.analysis_engine.impl that return SofaID
    Modifier and Type | Method and Description
    --- | ---
    `SofaID[]` | AnnotatorContext_impl.`getSofaMappings()` Deprecated. `AnnotatorContext.getSofaMappings()`
    `SofaID` | AnnotatorContext_impl.`mapToSofaID(String aSofaName)` Deprecated. `AnnotatorContext.mapToSofaID(java.lang.String)`

  - ### Uses of SofaID in org.apache.uima.cas

    Methods in org.apache.uima.cas with parameters of type SofaID
    Modifier and Type | Method and Description
    --- | ---
    `SofaFS` | CAS.`createSofa(SofaID sofaID, String mimeType)` Deprecated. As of v2.0, use `CAS.createView(String)` instead.
    `JCas` | CAS.`getJCas(SofaID aSofaID)` Deprecated. As of v2.0, use `CAS.getView(String)` followed by `CAS.getJCas()`.
    `SofaFS` | CAS.`getSofa(SofaID sofaID)` Deprecated. As of v2.0, use {#getView(String)}. From the view you can access the Sofa data, or call `CAS.getSofa()` if you truly need to access the SofaFS object.

  - ### Uses of SofaID in org.apache.uima.cas.impl

    Methods in org.apache.uima.cas.impl with parameters of type SofaID
    Modifier and Type | Method and Description
    --- | ---
    `SofaFS` | CASImpl.`createSofa(SofaID sofaID, String mimeType)` Deprecated.
    `JCas` | CASImpl.`getJCas(SofaID aSofaID)` Deprecated.
    `SofaFS` | CASImpl.`getSofa(SofaID sofaID)` Deprecated.

  - ### Uses of SofaID in org.apache.uima.impl

    Classes in org.apache.uima.impl that implement SofaID
    Modifier and Type | Class and Description
    --- | ---
    `class` | `SofaID_impl` Deprecated.

    Methods in org.apache.uima.impl that return SofaID
    Modifier and Type | Method and Description
    --- | ---
    `SofaID[]` | UimaContext_ImplBase.`getSofaMappings()` (non-Javadoc)
    `SofaID` | UimaContext_ImplBase.`mapToSofaID(String aSofaName)` Changes here should also be made in UimaContext_ImplBase.mapToSofaID (non-Javadoc)

  - ### Uses of SofaID in org.apache.uima.jcas

    Methods in org.apache.uima.jcas with parameters of type SofaID
    Modifier and Type | Method and Description
    --- | ---
    `SofaFS` | JCas.`createSofa(SofaID sofaID, String mimeType)` Deprecated. As of v2.0, use `JCas.createView(String)` instead.
    `Sofa` | JCas.`getSofa(SofaID sofaID)` Deprecated. As of v2.0, use {#getView(String)}. From the view you can access the Sofa data, or call `JCas.getSofa()` if you truly need to access the SofaFS object.

  - ### Uses of SofaID in org.apache.uima.jcas.cas

    Constructors in org.apache.uima.jcas.cas with parameters of type SofaID
    Constructor and Description
    `Sofa(JCas jcas, SofaID ID, String mimeType)` Deprecated. As of v2.0, use `JCasImpl.createView(String)` to create a view, which will also create the Sofa for that view.

  - ### Uses of SofaID in org.apache.uima.jcas.impl

    Methods in org.apache.uima.jcas.impl with parameters of type SofaID
    Modifier and Type | Method and Description
    --- | ---
    `SofaFS` | JCasImpl.`createSofa(SofaID sofaID, String mimeType)`
    `Sofa` | JCasImpl.`getSofa(SofaID sofaID)`

Copyright © 2006–2021 The Apache Software Foundation. All rights reserved.