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

- Packages that use SofaFS
  Package | Description
  --- | ---
  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.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 SofaFS in org.apache.uima.cas

    Methods in org.apache.uima.cas with type parameters of type SofaFS
    Modifier and Type | Method and Description
    --- | ---
    `<T extends SofaFS> FSIterator<T>` | CAS.`getSofaIterator()` Get iterator for all SofaFS in the CAS.

    Methods in org.apache.uima.cas that return SofaFS
    Modifier and Type | Method and Description
    --- | ---
    `SofaFS` | CAS.`createSofa(SofaID sofaID, String mimeType)` Deprecated. As of v2.0, use `CAS.createView(String)` instead.
    `SofaFS` | CAS.`getSofa()` Get the Sofa feature structure associated with this CAS view.
    `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.

    Methods in org.apache.uima.cas with parameters of type SofaFS
    Modifier and Type | Method and Description
    --- | ---
    `JCas` | CAS.`getJCas(SofaFS aSofa)` Create a JCas view for a Sofa.
    `CAS` | CAS.`getView(SofaFS aSofa)` Get the view for a Sofa (subject of analysis).

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

    Subinterfaces of SofaFS in org.apache.uima.cas.impl
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `SofaFSImpl` Deprecated. use Sofa instead

    Methods in org.apache.uima.cas.impl with type parameters of type SofaFS
    Modifier and Type | Method and Description
    --- | ---
    `<T extends SofaFS> FSIterator<T>` | CASImpl.`getSofaIterator()`

    Methods in org.apache.uima.cas.impl that return SofaFS
    Modifier and Type | Method and Description
    --- | ---
    `SofaFS` | CASImpl.`createSofa(SofaID sofaID, String mimeType)` Deprecated.
    `SofaFS` | CASImpl.`getSofa(SofaID sofaID)` Deprecated.

    Methods in org.apache.uima.cas.impl with parameters of type SofaFS
    Modifier and Type | Method and Description
    --- | ---
    `JCas` | CASImpl.`getJCas(SofaFS aSofa)`
    `InputStream` | CASImpl.`getSofaDataStream(SofaFS aSofa)`
    `CASImpl` | CASImpl.`getView(SofaFS aSofa)`

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

    Methods in org.apache.uima.jcas that return SofaFS
    Modifier and Type | Method and Description
    --- | ---
    `SofaFS` | JCas.`createSofa(SofaID sofaID, String mimeType)` Deprecated. As of v2.0, use `JCas.createView(String)` instead.

    Methods in org.apache.uima.jcas that return types with arguments of type SofaFS
    Modifier and Type | Method and Description
    --- | ---
    `FSIterator<SofaFS>` | JCas.`getSofaIterator()` Get iterator for all SofaFS in the CAS.

    Methods in org.apache.uima.jcas with parameters of type SofaFS
    Modifier and Type | Method and Description
    --- | ---
    `JCas` | JCas.`getView(SofaFS aSofa)` Get the view for a Sofa (subject of analysis).

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

    Classes in org.apache.uima.jcas.cas that implement SofaFS
    Modifier and Type | Class and Description
    --- | ---
    `class` | `Sofa`

    Methods in org.apache.uima.jcas.cas that return SofaFS
    Modifier and Type | Method and Description
    --- | ---
    `SofaFS` | AnnotationBase.`getSofa()`
    `SofaFS` | AnnotationBase_Type.`getSofa(int addr)` Deprecated.

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

    Methods in org.apache.uima.jcas.impl that return SofaFS
    Modifier and Type | Method and Description
    --- | ---
    `SofaFS` | JCasImpl.`createSofa(SofaID sofaID, String mimeType)`

    Methods in org.apache.uima.jcas.impl that return types with arguments of type SofaFS
    Modifier and Type | Method and Description
    --- | ---
    `FSIterator<SofaFS>` | JCasImpl.`getSofaIterator()`

    Methods in org.apache.uima.jcas.impl with parameters of type SofaFS
    Modifier and Type | Method and Description
    --- | ---
    `JCas` | JCasImpl.`getView(SofaFS aSofa)`

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