# Deprecated API

## Contents

- Deprecated Interfaces
- Deprecated Classes
- Deprecated Exceptions
- Deprecated Fields
- Deprecated Methods
- Deprecated Constructors

- Deprecated Interfaces
  Interface and Description
  org.apache.uima.analysis_engine.AnalysisProcessData
  org.apache.uima.analysis_engine.annotator.AnnotatorContext As of release 2.3.0, use UimaContext instead
  org.apache.uima.collection.base_cpm.CasDataInitializer As of v2.0, CAS Initializers are deprecated. A component that performs an operation like HTML detagging should instead be implemented as a "multi-Sofa" annotator. See org.apache.uima.examples.XmlDetagger for an example.
  org.apache.uima.collection.CasInitializer As of v2.0, CAS Initializers are deprecated. A component that performs an operation like HTML detagging should instead be implemented as a "multi-Sofa" annotator. See org.apache.uima.examples.XmlDetagger for an example.
  org.apache.uima.collection.CasInitializerDescription As of v2.0, CAS Initializers are deprecated. A component that performs an operation like HTML detagging should instead be implemented as a "multi-Sofa" annotator. See org.apache.uima.examples.XmlDetagger for an example.
  org.apache.uima.collection.metadata.CpeCollectionReaderCasInitializer As of v2.0 CAS Initializers are deprecated.
  org.apache.uima.cas.FeatureValuePath use `FeaturePath`
  org.apache.uima.analysis_engine.annotator.GenericAnnotator As of release 2.3.0, use CasAnnotator_ImplBase or JCasAnnotator_ImplBase instead
  org.apache.uima.analysis_engine.annotator.JTextAnnotator As of release 2.3.0, use JCasAnnotator_ImplBase instead
  org.apache.uima.resource.ResourceManagerPearWrapper
  org.apache.uima.cas.SofaID As of v2.0, this is no longer needed. CAS views can now be obtained directly using String identifiers, through the method `CAS.getView(String)`.
  org.apache.uima.analysis_engine.TaeDescription As of v2.0, `AnalysisEngineDescription` should be used instead. This interface no longer defines any additional methods beyond those in AnalysisEngineDescription.
  org.apache.uima.analysis_engine.TextAnalysisEngine As of v2.0, `AnalysisEngine` should be used instead. This interface no longer defines any additional methods beyond those in AnalysisEngine.
  org.apache.uima.analysis_engine.annotator.TextAnnotator As of release 2.3.0, use CasAnnotator_ImplBase or JCasAnnotator_ImplBase instead

- Deprecated Classes
  Class and Description
  org.apache.uima.analysis_engine.impl.AnalysisProcessData_impl since v2.0
  org.apache.uima.analysis_engine.annotator.Annotator_ImplBase As of release 2.3.0, use CasAnnotator_ImplBase or JCasAnnotator_ImplBase instead
  org.apache.uima.collection.base_cpm.CasDataInitializer_ImplBase As of v2.0, CAS Initializers are deprecated. A component that performs an operation like HTML detagging should instead be implemented as a "multi-Sofa" annotator. See org.apache.uima.examples.XmlDetagger for an example.
  org.apache.uima.collection.CasInitializer_ImplBase As of v2.0, CAS Initializers are deprecated. A component that performs an operation like HTML detagging should instead be implemented as a "multi-Sofa" annotator. See org.apache.uima.examples.XmlDetagger for an example.
  org.apache.uima.collection.impl.CasInitializerDescription_impl As of v2.0, CAS Initializers are deprecated.
  org.apache.uima.impl.CasInitializerFactory_impl As of v2.0, CAS Initializers are deprecated.
  org.apache.uima.analysis_engine.annotator.GenericAnnotator_ImplBase As of release 2.3.0, use CasAnnotator_ImplBase or JCasAnnotator_ImplBase instead
  org.apache.uima.analysis_engine.annotator.JTextAnnotator_ImplBase As of release 2.3.0, use JCasAnnotator_ImplBase instead
  org.apache.uima.flow.SimpleStepWithResultSpec For backwards compatibility with Capability Language Flow only. User-developed Flow Controllers should not use this.
  org.apache.uima.impl.SofaID_impl
  org.apache.uima.analysis_engine.impl.TaeDescription_impl since v2.0
  org.apache.uima.util.TCasToInlineXml As of v2.0, use `CasToInlineXml` instead.

- Deprecated Exceptions
  Exceptions and Description
  org.apache.uima.cas.ParsingException The Constraint Parser is not supported in externally released versions of UIMA

- Deprecated Fields
  Field and Description
  org.apache.uima.util.XMLParser.ParsingOptions.expandXIncludes XInclude is no longer supported
  org.apache.uima.cas.CAS.NAME_DEFAULT_TEXT_SOFA As of v2.0, this is replaced by `CAS.NAME_DEFAULT_SOFA`, and the value has changed. In general, user code should not need to refer to this name.
  org.apache.uima.analysis_engine.AnalysisEngine.PARAM_CONFIG_PARAM_SETTINGS use `Resource.PARAM_CONFIG_PARAM_SETTINGS`
  org.apache.uima.analysis_engine.AnalysisEngine.PARAM_RESOURCE_MANAGER use `Resource.PARAM_RESOURCE_MANAGER`

- Deprecated Methods
  Method and Description
  org.apache.uima.UIMAFramework._newDefaultResourceManagerPearWrapper()
  org.apache.uima.collection.metadata.CpeDescription.addCasInitializer(String) As of v2.0 CAS Initializers are deprecated.
  org.apache.uima.cas.impl.CASImpl.commitFS(FeatureStructure)
  org.apache.uima.analysis_engine.impl.ResultSpecification_impl.compile(TypeSystem) no longer needed, remove call to this
  org.apache.uima.analysis_engine.ResultSpecification.compile(TypeSystem) as of 2.2.2 Now called automatically internally when needed
  org.apache.uima.analysis_engine.impl.UimacppAnalysisEngineImpl.createAnalysisProcessData()
  org.apache.uima.cas.impl.CASImpl.createSofa(SofaID, String)
  org.apache.uima.cas.CAS.createSofa(SofaID, String) As of v2.0, use `CAS.createView(String)` instead.
  org.apache.uima.jcas.JCas.createSofa(SofaID, String) As of v2.0, use `JCas.createView(String)` instead.
  org.apache.uima.impl.ResourceSpecifierFactory_impl.createTaeDescription() since v2.0
  org.apache.uima.ResourceSpecifierFactory.createTaeDescription() As of v2.0, `ResourceSpecifierFactory.createAnalysisEngineDescription()` should be used instead.
  org.apache.uima.cas.impl.CASImpl.flush() Use `reset()`instead.
  org.apache.uima.cas.admin.CASMgr.flush() Use `reset()` instead.
  org.apache.uima.cas.impl.TypeImpl.getAppropriateFeatures()
  org.apache.uima.cas.Type.getAppropriateFeatures() Use `getFeatures()` instead.
  org.apache.uima.collection.base_cpm.CasDataCollectionReader.getCasDataInitializer() As of v2.0 CAS Initializers are deprecated.
  org.apache.uima.collection.metadata.CpeCollectionReader.getCasInitializer() As of v2.0 CAS Initializers are deprecated.
  org.apache.uima.collection.CollectionReader_ImplBase.getCasInitializer() As of v2.0 CAS Initializers are deprecated.
  org.apache.uima.collection.CollectionReader.getCasInitializer() As of v2.0 CAS Initializers are deprecated.
  org.apache.uima.collection.metadata.CpeCasProcessor.getDescriptor() Doesn't support the new import syntax. Use getCpeComponentDescriptor().findAbsoluteUrl() instead.
  org.apache.uima.cas.TypeSystem.getDirectlySubsumedTypes(Type) Use `getDirectSubtypes(Type)` instead.
  org.apache.uima.cas.impl.TypeImpl.getFeature(String)
  org.apache.uima.cas.impl.TypeSystemImpl.getFeature(String)
  org.apache.uima.resource.metadata.impl.ResourceManagerConfiguration_impl.getImport() `ResourceManagerConfiguration.getImport()`
  org.apache.uima.resource.metadata.ResourceManagerConfiguration.getImport() Use `ResourceManagerConfiguration.getImports()` instead. There may be many imports; this method only returns the first.
  org.apache.uima.resource.ResourceManager.getImportCache() Intended just for internal use.
  org.apache.uima.cas.impl.CASImpl.getJCas(SofaID)
  org.apache.uima.cas.CAS.getJCas(SofaID) As of v2.0, use `CAS.getView(String)` followed by `CAS.getJCas()`.
  org.apache.uima.resource.impl.PearSpecifier_impl.getParameters()
  org.apache.uima.resource.PearSpecifier.getParameters() These parameters only support string values. Better use `PearSpecifier.getPearParameters()`.
  org.apache.uima.resource.metadata.impl.MetaDataObject_impl.getPropertyDescriptors() - use getAttributes instead
  org.apache.uima.util.XMLInputSource.getRelativePathBase() Use `XMLInputSource.getURL()` instead.
  org.apache.uima.cas.impl.CASImpl.getSofa(SofaID)
  org.apache.uima.cas.CAS.getSofa(SofaID) 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.
  org.apache.uima.jcas.JCas.getSofa(SofaID) 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.
  org.apache.uima.analysis_engine.impl.AnnotatorContext_impl.getSofaMappings() `AnnotatorContext.getSofaMappings()`
  org.apache.uima.analysis_engine.annotator.AnnotatorContext.getSofaMappings() 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.
  org.apache.uima.UimaContext.getSofaMappings() 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.
  org.apache.uima.jcas.tcas.Annotation.getStart() Use `Annotation.getBegin()` instead.
  org.apache.uima.jcas.JCas.getType(TOP) use instance.jcasType instead - faster
  org.apache.uima.cas_data.impl.FeatureStructureImpl.isIndexed()
  org.apache.uima.cas_data.FeatureStructure.isIndexed() Use `FeatureStructure.getIndexed()` instead
  org.apache.uima.analysis_engine.impl.AnalysisEngineDescription_impl.listAttributes() never called anymore - getAdditionalAttributes called instead
  org.apache.uima.resource.metadata.impl.MetaDataObject_impl.listAttributes() - use getAttributes
  org.apache.uima.resource.metadata.impl.ConfigurationParameterSettings_impl.listAttributes() - use getAdditionalAttributes instead
  org.apache.uima.resource.metadata.MetaDataObject.listAttributes() - use getAttributes() instead, don't override it, use getAdditionalAttributes to specify additional ones
  org.apache.uima.util.impl.Log4jLogger_impl.log(String) use new function with log level
  org.apache.uima.util.impl.Logger_impl.log(String) use method with log level as parameter
  org.apache.uima.util.impl.JSR47Logger_impl.log(String) use new function with log level
  org.apache.uima.util.Logger.log(String) use new function with log level
  org.apache.uima.util.impl.Log4jLogger_impl.log(String, String, Object[]) use new function with log level
  org.apache.uima.util.impl.Logger_impl.log(String, String, Object[]) use method with log level as parameter
  org.apache.uima.util.impl.JSR47Logger_impl.log(String, String, Object[]) use new function with log level
  org.apache.uima.util.Logger.log(String, String, Object[]) use new function with log level
  org.apache.uima.util.impl.Log4jLogger_impl.logException(Exception) use new function with log level
  org.apache.uima.util.impl.Logger_impl.logException(Exception) use method with log level as parameter
  org.apache.uima.util.impl.JSR47Logger_impl.logException(Exception) use new function with log level
  org.apache.uima.util.Logger.logException(Exception) use new function with log level
  org.apache.uima.analysis_engine.impl.AnnotatorContext_impl.mapToSofaID(String) `AnnotatorContext.mapToSofaID(java.lang.String)`
  org.apache.uima.analysis_engine.annotator.AnnotatorContext.mapToSofaID(String) 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.
  org.apache.uima.UimaContext.mapToSofaID(String) 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.
  org.apache.uima.UIMAFramework.newDefaultResourceManagerPearWrapper()
  org.apache.uima.util.impl.XMLParser_impl.parseCasInitializerDescription(XMLInputSource)
  org.apache.uima.util.impl.XMLParser_impl.parseCasInitializerDescription(XMLInputSource, XMLParser.ParsingOptions)
  org.apache.uima.util.impl.XMLParser_impl.parseTaeDescription(XMLInputSource) since v2.0
  org.apache.uima.util.XMLParser.parseTaeDescription(XMLInputSource) As of v2.0, `XMLParser.parseAnalysisEngineDescription(XMLInputSource)` should be used instead.
  org.apache.uima.util.impl.XMLParser_impl.parseTaeDescription(XMLInputSource, XMLParser.ParsingOptions) since v2.0
  org.apache.uima.util.XMLParser.parseTaeDescription(XMLInputSource, XMLParser.ParsingOptions) As of v2.0, `XMLParser.parseAnalysisEngineDescription(XMLInputSource,ParsingOptions)` should be used instead.
  org.apache.uima.analysis_engine.impl.AnalysisEngineImplBase.process(AnalysisProcessData, ResultSpecification)
  org.apache.uima.analysis_engine.AnalysisEngine.process(AnalysisProcessData, ResultSpecification) This is no longer used by the framework and was never intended for users to call. Use {#link #process(CAS)} instead.
  org.apache.uima.jcas.JCas.processInit() not required, does nothing
  org.apache.uima.UIMAFramework.produceCasInitializer(ResourceSpecifier) As of v2.0, CAS Initializers are deprecated. A component that performs an operation like HTML detagging should instead be implemented as a "multi-Sofa" annotator. See org.apache.uima.examples.XmlDetagger for an example.
  org.apache.uima.UIMAFramework.produceTAE(ResourceSpecifier) As of v2.0, `UIMAFramework.produceAnalysisEngine(ResourceSpecifier)` should be used instead.
  org.apache.uima.UIMAFramework.produceTAE(ResourceSpecifier, int, int) As of v2.0, `UIMAFramework.produceAnalysisEngine(ResourceSpecifier,int,int)` should be used instead.
  org.apache.uima.UIMAFramework.produceTAE(ResourceSpecifier, Map<String, Object>) As of v2.0, `UIMAFramework.produceAnalysisEngine(ResourceSpecifier,Map)` should be used instead.
  org.apache.uima.UIMAFramework.produceTAE(ResourceSpecifier, ResourceManager, Map<String, Object>) As of v2.0, `UIMAFramework.produceAnalysisEngine(ResourceSpecifier,ResourceManager,Map)` should be used instead.
  org.apache.uima.flow.CasFlow_ImplBase.setCas(CAS) this is automatically done by the framework after a new flow object is created
  org.apache.uima.collection.base_cpm.CasDataCollectionReader.setCasInitializer(CasDataInitializer) As of v2.0 CAS Initializers are deprecated.
  org.apache.uima.collection.CollectionReader_ImplBase.setCasInitializer(CasInitializer) As of v2.0 CAS Initializers are deprecated.
  org.apache.uima.collection.CollectionReader.setCasInitializer(CasInitializer) As of v2.0 CAS Initializers are deprecated.
  org.apache.uima.collection.metadata.CpeCollectionReader.setCasInitializer(CpeCollectionReaderCasInitializer) As of v2.0 CAS Initializers are deprecated.
  org.apache.uima.collection.metadata.CpeCasProcessor.setDescriptor(String) Doesn't support the new import syntax. Use setCpeComponentDescriptor() instead.
  org.apache.uima.resource.metadata.impl.ResourceManagerConfiguration_impl.setImport(Import) `ResourceManagerConfiguration.setImport(Import)`
  org.apache.uima.resource.metadata.ResourceManagerConfiguration.setImport(Import) Use `ResourceManagerConfiguration.setImports(Import[])` instead.
  org.apache.uima.cas_data.impl.FeatureStructureImpl.setIndexed(boolean)
  org.apache.uima.cas_data.FeatureStructure.setIndexed(boolean) Use `FeatureStructure.setIndexed(int[])` instead
  org.apache.uima.flow.JCasFlow_ImplBase.setJCas(JCas) this is done automatically by the framework with the Flow object is created
  org.apache.uima.util.impl.Log4jLogger_impl.setOutputStream(OutputStream) use external configuration possibility
  org.apache.uima.util.impl.Logger_impl.setOutputStream(OutputStream) use external configuration possibility
  org.apache.uima.util.impl.JSR47Logger_impl.setOutputStream(OutputStream) use external configuration possibility
  org.apache.uima.util.Logger.setOutputStream(OutputStream) use external configuration possibility
  org.apache.uima.util.impl.Log4jLogger_impl.setOutputStream(PrintStream) use external configuration possibility
  org.apache.uima.util.impl.Logger_impl.setOutputStream(PrintStream) use external configuration possibility
  org.apache.uima.util.impl.JSR47Logger_impl.setOutputStream(PrintStream) use external configuration possibility
  org.apache.uima.util.Logger.setOutputStream(PrintStream) use external configuration possibility
  org.apache.uima.resource.impl.PearSpecifier_impl.setParameters(Parameter...)
  org.apache.uima.resource.PearSpecifier.setParameters(Parameter...) These parameters only support string values. Better use `PearSpecifier.setPearParameters(org.apache.uima.resource.metadata.NameValuePair...)`.
  org.apache.uima.pear.tools.InstallationDescriptor.updateMainComponentId(String) Use setMainComponentId() method instead.

- Deprecated Constructors
  Constructor and Description
  org.apache.uima.util.JCasPool(int, TextAnalysisEngine) As of v2.0, TextAnalysisEngine has been deprecated. Use `JCasPool(int, AnalysisEngine)` instead.
  org.apache.uima.util.XMLParser.ParsingOptions(boolean, boolean) XInclude is no longer supported
  org.apache.uima.util.impl.SaxDeserializer_impl(XMLParser, String, URL, XMLParser.ParsingOptions) Use `SaxDeserializer_impl(XMLParser, XMLParser.ParsingOptions)` instead.
  org.apache.uima.jcas.cas.Sofa(JCas, SofaID, String) As of v2.0, use `JCasImpl.createView(String)` to create a view, which will also create the Sofa for that view.
  org.apache.uima.cas.impl.TypeSystemImpl(CASImpl) Use 0 arg constructor. Type Systems are shared by many CASes, and can't point to one. Change also your possible calls to ts.commit() - see comment on that method.
  org.apache.uima.cas.impl.XmiCasSerializer(TypeSystem, UimaContext) Use `XmiCasSerializer(TypeSystem)` instead. The UimaContext reference is never used by this implementation.
  org.apache.uima.cas.impl.XmiCasSerializer(TypeSystem, UimaContext, Map<String, String>) Use `XmiCasSerializer(TypeSystem, Map)` instead. The UimaContext reference is never used by this implementation.

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