## Uses of Interface
org.apache.uima.util.XMLizable

- Packages that use XMLizable
  Package | Description
  --- | ---
  org.apache.uima.analysis_engine | The Analysis Engine interface, along with supporting interfaces and exception classes.
  org.apache.uima.analysis_engine.impl |
  org.apache.uima.analysis_engine.metadata | Interfaces for objects that represent metadata for an Analysis Engine.
  org.apache.uima.analysis_engine.metadata.impl |
  org.apache.uima.collection | Classes and interfaces for collection processing.
  org.apache.uima.collection.impl |
  org.apache.uima.collection.metadata | Java object representation of a CPE Descriptor.
  org.apache.uima.flow |
  org.apache.uima.flow.impl |
  org.apache.uima.json |
  org.apache.uima.resource | Interfaces for `Resources` and `ResourceSpecifiers`.
  org.apache.uima.resource.impl |
  org.apache.uima.resource.metadata | Interfaces for objects that represent metadata for a Resource.
  org.apache.uima.resource.metadata.impl |
  org.apache.uima.search | Standard UIMA interfaces for indexing and search.
  org.apache.uima.search.impl | Search engine-independent indexing classes.
  org.apache.uima.util | Utility classes and interfaces used by UIMA components.
  org.apache.uima.util.impl |

- - ### Uses of XMLizable in org.apache.uima.analysis_engine

    Subinterfaces of XMLizable in org.apache.uima.analysis_engine
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `AnalysisEngineDescription` An `AnalysisEngineDescription` contains all of the information needed to instantiate and use an `AnalysisEngine`.
    `interface` | `ResultSpecification` A `ResultSpecification` is a set of desired outputs from a Analysis Engine or Annotator.
    `interface` | `TaeDescription` Deprecated. As of v2.0, `AnalysisEngineDescription` should be used instead. This interface no longer defines any additional methods beyond those in AnalysisEngineDescription.
    `interface` | `TypeOrFeature` A reference to a Type or Feature in the Analysis Engine's TypeSystem.

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

    Classes in org.apache.uima.analysis_engine.impl that implement XMLizable
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AnalysisEngineDescription_impl` Reference implementation of `AnalysisEngineDescription`.
    `class` | `ResultSpecification_impl` Reference implementation of `ResultSpecification`.
    `class` | `TaeDescription_impl` Deprecated. since v2.0
    `class` | `TypeOrFeature_impl` Reference implementation of `TypeOrFeature`.

  - ### Uses of XMLizable in org.apache.uima.analysis_engine.metadata

    Subinterfaces of XMLizable in org.apache.uima.analysis_engine.metadata
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `AnalysisEngineMetaData` Encapsulates all of the metadata for an Analysis Engine.
    `interface` | `CapabilityLanguageFlow` A `CapabilityLanguageFlow` is a simple type of `FlowConstraints` that specifies the complete flow as a capabilityLanguage sequence.
    `interface` | `FixedFlow` A `FixedFlow` is a simple type of `FlowConstraints` that specifies the complete flow as a fixed sequence.
    `interface` | `FlowConstraints` A `FlowConstraints` object represents constraints on the order of execution of delegate Analysis Engines within an aggregate Analysis Engine.
    `interface` | `FlowControllerDeclaration` Declares which FlowController is used by the Aggregate Analysis Engine.
    `interface` | `SofaMapping` Sofa Name mapping is required to connect the output Sofas from one component to the input Sofa of another component.

  - ### Uses of XMLizable in org.apache.uima.analysis_engine.metadata.impl

    Classes in org.apache.uima.analysis_engine.metadata.impl that implement XMLizable
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AnalysisEngineMetaData_impl` Reference implementation of `AnalysisEngineMetaData`.
    `class` | `CapabilityLanguageFlow_impl` A `CapabilityLanguageFlow` is a simple type of `FlowConstraints` that specifies the complete flow as a capabilityLanguage sequence.
    `class` | `FixedFlow_impl` Reference implementation of `FixedFlow`.
    `class` | `FlowControllerDeclaration_impl` Declares which FlowController is used by the Aggregate Analysis Engine.
    `class` | `SofaMapping_impl` Implementation of `SofaMapping`.

  - ### Uses of XMLizable in org.apache.uima.collection

    Subinterfaces of XMLizable in org.apache.uima.collection
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `CasConsumerDescription` An `CasConsumerDescription` contains all of the information needed to instantiate and use an `CasConsumer`.
    `interface` | `CasInitializerDescription` Deprecated. 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.
    `interface` | `CollectionReaderDescription` An `CollectionReaderDescription` contains all of the information needed to instantiate and use an `CollectionReader`.

  - ### Uses of XMLizable in org.apache.uima.collection.impl

    Classes in org.apache.uima.collection.impl that implement XMLizable
    Modifier and Type | Class and Description
    --- | ---
    `class` | `CasConsumerDescription_impl`
    `class` | `CasInitializerDescription_impl` Deprecated. As of v2.0, CAS Initializers are deprecated.
    `class` | `CollectionReaderDescription_impl`

  - ### Uses of XMLizable in org.apache.uima.collection.metadata

    Subinterfaces of XMLizable in org.apache.uima.collection.metadata
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `CasProcessorDeploymentParam` An object that holds configuration information used for building CPE Descriptor.
    `interface` | `CasProcessorErrorHandling` An object to contains configuration specific to error handling applicable to every CasProcossor.
    `interface` | `CasProcessorErrorRateThreshold` An object to contains configuration specific to error handling applicable to every CasProcessor.
    `interface` | `CasProcessorExecArg` An object containing an arbitrary value that will passed to a program launched by the CPE.
    `interface` | `CasProcessorExecutable` An object containing configuration for a program that the CPE will use to launch CasProcessor.
    `interface` | `CasProcessorFilter` Object containing a filter expression used by the CPE to route CAS's to CasProcessor.
    `interface` | `CasProcessorMaxRestarts` An object that holds configuration related to handling max restarts for CasProcessors.
    `interface` | `CasProcessorRunInSeperateProcess` An object that holds configuration that is part of the CPE descriptor.
    `interface` | `CasProcessorRuntimeEnvParam` An object that holds configuration that is part of the CPE descriptor.
    `interface` | `CasProcessorTimeout` An object that holds configuration that is part of the CPE descriptor.
    `interface` | `CpeCasProcessor` An object that holds configuration that is part of the CPE descriptor.
    `interface` | `CpeCasProcessors` An object that holds configuration that is part of the CPE descriptor.
    `interface` | `CpeCheckpoint` An object that holds configuration that is part of the CPE descriptor.
    `interface` | `CpeCollectionReader` An object that holds configuration that is part of the CPE descriptor.
    `interface` | `CpeCollectionReaderCasInitializer` Deprecated. As of v2.0 CAS Initializers are deprecated.
    `interface` | `CpeCollectionReaderIterator` An object that holds configuration that is part of the CPE descriptor.
    `interface` | `CpeComponentDescriptor` An object that holds configuration that is part of the CPE descriptor.
    `interface` | `CpeConfiguration` An object that holds configuration that is part of the CPE descriptor.
    `interface` | `CpeDescription` Java representation of a Collection Processing Engine (CPE) XML descriptor.
    `interface` | `CpeInclude` An object that holds configuration that is part of the CPE descriptor.
    `interface` | `CpeIntegratedCasProcessor` An object that holds configuration that is part of the CPE descriptor.
    `interface` | `CpeLocalCasProcessor` An object that holds configuration that is part of the CPE descriptor.
    `interface` | `CpeRemoteCasProcessor` An object that holds configuration that is part of the CPE descriptor.
    `interface` | `CpeResourceManagerConfiguration` An object that holds configuration that is part of the CPE descriptor.
    `interface` | `CpeSofaMapping`
    `interface` | `CpeSofaMappings`
    `interface` | `OutputQueue` An object that holds configuration that is part of the CPE descriptor.

  - ### Uses of XMLizable in org.apache.uima.flow

    Subinterfaces of XMLizable in org.apache.uima.flow
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `FlowControllerDescription` A `FlowControllerDescription` contains all of the information needed to instantiate and use a `FlowController`.

  - ### Uses of XMLizable in org.apache.uima.flow.impl

    Classes in org.apache.uima.flow.impl that implement XMLizable
    Modifier and Type | Class and Description
    --- | ---
    `class` | `FlowControllerDescription_impl` Implementation of `FlowControllerDescription`.

  - ### Uses of XMLizable in org.apache.uima.json

    Methods in org.apache.uima.json with parameters of type XMLizable
    Modifier and Type | Method and Description
    --- | ---
    `static void` | JsonMetaDataSerializer.`toJSON(XMLizable object, File file)`
    `static void` | JsonMetaDataSerializer.`toJSON(XMLizable object, File file, boolean isFormattedOutput)`
    `static void` | JsonMetaDataSerializer.`toJSON(XMLizable object, com.fasterxml.jackson.core.JsonGenerator jg, boolean isFormattedOutput)` Serialize use a specific instance of a JsonGenerator which encapsulates where the output goes
    `static void` | JsonMetaDataSerializer.`toJSON(XMLizable object, OutputStream aOutputStream)` Writes out this object's JSON representation.
    `static void` | JsonMetaDataSerializer.`toJSON(XMLizable object, OutputStream aOutputStream, boolean isFormattedOutput)`
    `static void` | JsonMetaDataSerializer.`toJSON(XMLizable object, Writer aWriter)` Serialize to a writer
    `static void` | JsonMetaDataSerializer.`toJSON(XMLizable object, Writer aWriter, boolean isFormattedOutput)` Serialize to a writer

  - ### Uses of XMLizable in org.apache.uima.resource

    Subinterfaces of XMLizable in org.apache.uima.resource
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `ConfigurableDataResourceSpecifier` A type of `ResourceSpecifier` that locates a resource file using its URL.
    `interface` | `CustomResourceSpecifier` A type of `ResourceSpecifier` that specifically names the Java class that should be created.
    `interface` | `ExternalResourceDependency` An `ExternalResourceDependency` object describes an resources's requirements on an external resource.
    `interface` | `ExternalResourceDescription` An `ExternalResourceDescription` object describes a resource that is loaded in the `ResourceManager` and may be shared between components.
    `interface` | `FileLanguageResourceSpecifier` A type of `ResourceSpecifier` that locates a resource file using its URL, where the URL depends on an ISO language identifier.
    `interface` | `FileResourceSpecifier` A type of `ResourceSpecifier` that locates a resource file using its URL.
    `interface` | `JMSMessagingSpecifier`
    `interface` | `MailMessagingSpecifier`
    `interface` | `MessagingSpecifier`
    `interface` | `MQMessagingSpecifier`
    `interface` | `Parameter` A general parameter having a name and a value, which are both strings.
    `interface` | `PearSpecifier` A type of `ResourceSpecifier` that locate an installed pear `Resource`.
    `interface` | `ResourceCreationSpecifier` A `ResourceCreationSpecifier` is the supertype of `AnalysisEngineDescription`, `CasConsumerDescription`, `CollectionReaderDescription`, and `CasInitializerDescription`.
    `interface` | `ResourceServiceSpecifier` A `ResourceServiceSpecifier` is a type of `ResourceSpecifier` that contains information that can be used to locate an existing resource available as a service.
    `interface` | `ResourceSpecifier` A `ResourceSpecifier` contains information that can be used acquire a reference to a `Resource`, whether that is done by instantiating the resource locally or locating an existing resource available as a service.
    `interface` | `ResourceSpecifierList` A type of `ResourceSpecifier` that is an aggregate of other `ResourceSpecifier`s.
    `interface` | `URISpecifier` A type of `ResourceSpecifier` that locates an existing `Resource` service by its URI.

    Methods in org.apache.uima.resource that return types with arguments of type XMLizable
    Modifier and Type | Method and Description
    --- | ---
    `Map<String,XMLizable>` | ResourceManager.`getImportCache()` Deprecated. Intended just for internal use.

  - ### Uses of XMLizable in org.apache.uima.resource.impl

    Classes in org.apache.uima.resource.impl that implement XMLizable
    Modifier and Type | Class and Description
    --- | ---
    `class` | `ConfigurableDataResourceSpecifier_impl` Reference implementation of `FileResourceSpecifier`.
    `class` | `CustomResourceSpecifier_impl` Implementation of `CustomResourceSpecifier`.
    `class` | `ExternalResourceDependency_impl` Reference implementation of `ExternalResourceDependency`.
    `class` | `ExternalResourceDescription_impl` Reference implementation of `AnalysisEngineDescription`.
    `class` | `FileLanguageResourceSpecifier_impl` Reference implementation of `FileLanguageResourceSpecifier`.
    `class` | `FileResourceSpecifier_impl` Reference implementation of `FileResourceSpecifier`.
    `class` | `Parameter_impl`
    `class` | `PearSpecifier_impl` Reference implementation of `PearSpecifier`.
    `class` | `ResourceCreationSpecifier_impl` Reference implementation of `ResourceCreationSpecifier`.
    `class` | `URISpecifier_impl` Reference implementation of `URISpecifier`.

    Methods in org.apache.uima.resource.impl that return types with arguments of type XMLizable
    Modifier and Type | Method and Description
    --- | ---
    `Map<String,XMLizable>` | ResourceManager_impl.`getImportCache()`

  - ### Uses of XMLizable in org.apache.uima.resource.metadata

    Subinterfaces of XMLizable in org.apache.uima.resource.metadata
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `AllowedValue` Represents an allowed value for an "enumerated" type.
    `interface` | `Capability` A `Capability` defines an operation that an Resource can carry out.
    `interface` | `ConfigurationGroup` A group of `ConfigurationParameter`s.
    `interface` | `ConfigurationParameter` Completely specifies a configuration parameter on a UIMA resource.
    `interface` | `ConfigurationParameterDeclarations` The declarations of configuration parameters in a Resource.
    `interface` | `ConfigurationParameterSettings` The values for `ConfigurationParameter`s in a Resource.
    `interface` | `ExternalResourceBinding` Binds an `ExternalResourceDependency` to an `ExternalResourceDescription`.
    `interface` | `FeatureDescription` A description of a CAS feature.
    `interface` | `FsIndexCollection` Description of a collection of CAS feature structure indexes.
    `interface` | `FsIndexDescription` A description of a CAS feature structure index.
    `interface` | `FsIndexKeyDescription` A description of a key defining a CAS feature structure index.
    `interface` | `Import` An import declaration.
    `interface` | `LanguagePrecondition` A precondition on the language of the document.
    `interface` | `MetaDataObject` An object used to represent metadata of a `Resource`.
    `interface` | `MimeTypePrecondition` A precondition on the MIME Type of the entity.
    `interface` | `NameValuePair` A type of `MetaDataObject` that stores a name (String) and value (Object).
    `interface` | `Precondition` A `Precondition` of a Resource is a condition that an Entity and/or its analysis in the `CAS` must satisfy before that Entity can be processed by the Resource.
    `interface` | `ProcessingResourceMetaData` Metadata that describes a "Processing" `Resource` - that is, one that reads or writes to the `CAS`.
    `interface` | `ResourceManagerConfiguration` Defines a set of external resources and their bindings to `ExternalResourceDependencies`.
    `interface` | `ResourceMetaData` Encapsulates all metadata for a `Resource`.
    `interface` | `SimplePrecondition` `SimplePrecondition` defines a few simple conditions that can be evaluated against a `CAS`.
    `interface` | `TypeDescription` A description of a CAS Type.
    `interface` | `TypePriorities` A declaration of priorities between CAS Types.
    `interface` | `TypePriorityList` Declares a relative priority between CAS types.
    `interface` | `TypeSystemDescription` Description of a CAS TypeSystem.

  - ### Uses of XMLizable in org.apache.uima.resource.metadata.impl

    Classes in org.apache.uima.resource.metadata.impl that implement XMLizable
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AllowedValue_impl` Reference implementation of `AllowedValue`.
    `class` | `Capability_impl` Reference implementation of `Capability`
    `class` | `ConfigurationGroup_impl` Reference implementation of `ConfigurationGroup`.
    `class` | `ConfigurationParameter_impl` Reference implementation of `ConfigurationParameter`.
    `class` | `ConfigurationParameterDeclarations_impl`
    `class` | `ConfigurationParameterSettings_impl` Reference implementation of `ConfigurationParameterSettings`.
    `class` | `ExternalResourceBinding_impl`
    `class` | `FeatureDescription_impl` Reference implementation of `FeatureDescription`.
    `class` | `FsIndexCollection_impl`
    `class` | `FsIndexDescription_impl`
    `class` | `FsIndexKeyDescription_impl`
    `class` | `Import_impl`
    `class` | `LanguagePrecondition_impl` Precondition that tests language of the document.
    `class` | `MetaDataObject_impl` Abstract base class for all MetaDataObjects in the reference implementation.
    `class` | `MimeTypePrecondition_impl` Precondition that tests the MIME type of the Entity's content.
    `class` | `NameValuePair_impl` Reference implementation of `NameValuePair`.
    `class` | `OperationalProperties_impl`
    `class` | `ProcessingResourceMetaData_impl` Reference implementation of `ProcessingResourceMetaData`.
    `class` | `ResourceManagerConfiguration_impl`
    `class` | `ResourceMetaData_impl` Reference implementation of `ResourceMetaData`.
    `class` | `SimplePrecondition_impl` Reference implementation of `SimplePrecondition`.
    `class` | `TypeDescription_impl` Reference implementation of `TypeDescription`.
    `class` | `TypePriorities_impl` Reference implementation of `TypePriorities`.
    `class` | `TypePriorityList_impl` Reference implementation of `TypePriorityList`.
    `class` | `TypeSystemDescription_impl` Reference implementation of `TypeSystemDescription`.

  - ### Uses of XMLizable in org.apache.uima.search

    Subinterfaces of XMLizable in org.apache.uima.search
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `Attribute` A simple name, value pair that is specified as part of a `Style` to further define its behavior.
    `interface` | `Filter` Specifies a constraint that matches against annotations in the CAS.
    `interface` | `IndexBuildItem` An individual item within a `IndexBuildSpecification`.
    `interface` | `IndexBuildSpecification` Determines how a `CAS` get indexed with a UIMA-compliant search engine.
    `interface` | `IndexRule` A rule that specifies indexing behavior.
    `interface` | `Style` An indexing style.

  - ### Uses of XMLizable in org.apache.uima.search.impl

    Classes in org.apache.uima.search.impl that implement XMLizable
    Modifier and Type | Class and Description
    --- | ---
    `class` | `Attribute_impl`
    `class` | `Filter_impl`
    `class` | `IndexBuildItem_impl`
    `class` | `IndexBuildSpecification_impl`
    `class` | `IndexRule_impl`
    `class` | `Mapping_impl`
    `class` | `Style_impl`

  - ### Uses of XMLizable in org.apache.uima.util

    Methods in org.apache.uima.util that return XMLizable
    Modifier and Type | Method and Description
    --- | ---
    `XMLizable` | XMLParser.`buildObject(Element aElement)` Builds an object from its XML DOM representation.
    `XMLizable` | XMLParser.`buildObject(Element aElement, XMLParser.ParsingOptions aOptions)` Builds an object from its XML DOM representation.
    `XMLizable` | SaxDeserializer.`getObject()` Retrieves the `XMLizable` object that has been built from the SAX events this object has already received.
    `XMLizable` | XMLParser.`parse(XMLInputSource aInput)` Parses an XML input stream and produces an object.
    `XMLizable` | XMLParser.`parse(XMLInputSource aInput, String aNamespaceForSchema, URL aSchemaUrl)` Parses an XML input stream and produces an object.
    `XMLizable` | XMLParser.`parse(XMLInputSource aInput, String aNamespaceForSchema, URL aSchemaUrl, XMLParser.ParsingOptions aOptions)` Parses an XML input stream and produces an object.
    `XMLizable` | XMLParser.`parse(XMLInputSource aInput, XMLParser.ParsingOptions aOptions)` Parses an XML input stream and produces an object.

  - ### Uses of XMLizable in org.apache.uima.util.impl

    Fields in org.apache.uima.util.impl with type parameters of type XMLizable
    Modifier and Type | Field and Description
    --- | ---
    `protected Map<String,Class<? extends XMLizable>>` | XMLParser_impl.`mElementToClassMap` Map from XML element names to Class objects.

    Methods in org.apache.uima.util.impl that return XMLizable
    Modifier and Type | Method and Description
    --- | ---
    `XMLizable` | XMLParser_impl.`buildObject(Element aElement)` Builds an object from its XML DOM representation.
    `XMLizable` | XMLParser_impl.`buildObject(Element aElement, XMLParser.ParsingOptions aOptions)` Builds an object from its XML DOM representation.
    `XMLizable` | SaxDeserializer_impl.`getObject()`
    `XMLizable` | XMLParser_impl.`parse(XMLInputSource aInput)` Parses an XML input stream and produces an object.
    `XMLizable` | XMLParser_impl.`parse(XMLInputSource aInput, String aNamespaceForSchema, URL aSchemaUrl)` Parses an XML input stream and produces an object.
    `XMLizable` | XMLParser_impl.`parse(XMLInputSource aInput, String aNamespaceForSchema, URL aSchemaUrl, XMLParser.ParsingOptions aOptions)` Parses an XML input stream and produces an object.
    `XMLizable` | XMLParser_impl.`parse(XMLInputSource aInput, XMLParser.ParsingOptions aOptions)`

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