Package org.apache.tika.parser.ctakes

Class CTAKESConfig

java.lang.Object
org.apache.tika.parser.ctakes.CTAKESConfig
All Implemented Interfaces:
Serializable
@Deprecated(since="2026-04-30") public class CTAKESConfig extends Object implements Serializable
Deprecated.
This version of the Apache Tika library is deprecated. Use your own version of Apache Tika.
Configuration for CTAKESContentHandler. This class allows to enable cTAKES and set its parameters.
See Also:

  • Constructor Details

    • CTAKESConfig

      public CTAKESConfig()
      Deprecated.
      Default constructor.

    • CTAKESConfig

      public CTAKESConfig(InputStream stream)
      Deprecated.
      Loads properties from InputStream and then tries to close InputStream.
      Parameters:
      stream - InputStream object used to read properties.

  • Method Details

    • getAeDescriptorPath

      public String getAeDescriptorPath()
      Deprecated.
      Returns the path to XML descriptor for AnalysisEngine.
      Returns:
      the path to XML descriptor for AnalysisEngine.

    • getUMLSUser

      public String getUMLSUser()
      Deprecated.
      Returns the UMLS username.
      Returns:
      the UMLS username.

    • getUMLSPass

      public String getUMLSPass()
      Deprecated.
      Returns the UMLS password.
      Returns:
      the UMLS password.

    • isPrettyPrint

      public boolean isPrettyPrint()
      Deprecated.
      Returns true if formatted output is enabled, false otherwise.
      Returns:
      true if formatted output is enabled, false otherwise.

    • getSerializerType

      public CTAKESSerializer getSerializerType()
      Deprecated.
      Returns the type of cTAKES (UIMA) serializer used to write the CAS.
      Returns:
      the type of cTAKES serializer.

    • getOutputStream

      public OutputStream getOutputStream()
      Deprecated.
      Returns an OutputStream object used write the CAS.
      Returns:
      OutputStream object used write the CAS.

    • isSerialize

      public boolean isSerialize()
      Deprecated.
      Returns true if CAS serialization is enabled, false otherwise.
      Returns:
      true if CAS serialization output is enabled, false otherwise.

    • isText

      public boolean isText()
      Deprecated.
      Returns true if content text analysis is enabled false otherwise.
      Returns:
      true if content text analysis is enabled false otherwise.

    • getMetadata

      public String[] getMetadata()
      Deprecated.
      Returns an array of metadata whose values will be analyzed using cTAKES.
      Returns:
      an array of metadata whose values will be analyzed using cTAKES.

    • getMetadataAsString

      public String getMetadataAsString()
      Deprecated.
      Returns a string containing a comma-separated list of metadata whose values will be analyzed using cTAKES.
      Returns:
      a string containing a comma-separated list of metadata whose values will be analyzed using cTAKES.

    • getAnnotationProps

      public CTAKESAnnotationProperty[] getAnnotationProps()
      Deprecated.
      Returns an array of CTAKESAnnotationProperty's that will be included into cTAKES metadata.
      Returns:
      an array of CTAKESAnnotationProperty's that will be included into cTAKES metadata.

    • getAnnotationPropsAsString

      public String getAnnotationPropsAsString()
      Deprecated.
      Returns a string containing a comma-separated list of CTAKESAnnotationProperty names that will be included into cTAKES metadata.
      Returns:

    • getSeparatorChar

      public char getSeparatorChar()
      Deprecated.
      Returns the separator character used for annotation properties.
      Returns:
      the separator character used for annotation properties.

    • setAeDescriptorPath

      public void setAeDescriptorPath(String aeDescriptorPath)
      Deprecated.
      Sets the path to XML descriptor for AnalysisEngine.
      Parameters:
      aeDescriptorPath - the path to XML descriptor for AnalysisEngine.

    • setUMLSUser

      public void setUMLSUser(String uMLSUser)
      Deprecated.
      Sets the UMLS username.
      Parameters:
      uMLSUser - the UMLS username.

    • setUMLSPass

      public void setUMLSPass(String uMLSPass)
      Deprecated.
      Sets the UMLS password.
      Parameters:
      uMLSPass - the UMLS password.

    • setPrettyPrint

      public void setPrettyPrint(boolean prettyPrint)
      Deprecated.
      Enables the formatted output for serializer.
      Parameters:
      prettyPrint - true to enable formatted output, false otherwise.

    • setSerializerType

      public void setSerializerType(CTAKESSerializer serializerType)
      Deprecated.
      Sets the type of cTAKES (UIMA) serializer used to write CAS.
      Parameters:
      serializerType - the type of cTAKES serializer.

    • setOutputStream

      public void setOutputStream(OutputStream stream)
      Deprecated.
      Sets the OutputStream object used to write the CAS.
      Parameters:
      stream - the OutputStream object used to write the CAS.

    • setSerialize

      public void setSerialize(boolean serialize)
      Deprecated.
      Enables CAS serialization.
      Parameters:
      serialize - true to enable CAS serialization, false otherwise.

    • setText

      public void setText(boolean text)
      Deprecated.
      Enables content text analysis using cTAKES.
      Parameters:
      text - true to enable content text analysis, false otherwise.

    • setMetadata

      public void setMetadata(String[] metadata)
      Deprecated.
      Sets the metadata whose values will be analyzed using cTAKES.
      Parameters:
      metadata - the metadata whose values will be analyzed using cTAKES.

    • setAnnotationProps

      public void setAnnotationProps(CTAKESAnnotationProperty[] annotationProps)
      Deprecated.
      Sets the CTAKESAnnotationProperty's that will be included into cTAKES metadata.
      Parameters:
      annotationProps - the CTAKESAnnotationProperty's that will be included into cTAKES metadata.

    • setAnnotationProps

      public void setAnnotationProps(String[] annotationProps)
      Deprecated.
      ets the CTAKESAnnotationProperty's that will be included into cTAKES metadata.
      Parameters:
      annotationProps - the CTAKESAnnotationProperty's that will be included into cTAKES metadata.

    • setSeparatorChar

      public void setSeparatorChar(char separatorChar)
      Deprecated.
      Sets the separator character used for annotation properties.
      Parameters:
      separatorChar - the separator character used for annotation properties.