CTAKESConfig (Apache Tika 1.18 API)

java.lang.Object
- org.apache.tika.parser.ctakes.CTAKESConfig

All Implemented Interfaces:

Serializable
```
public class CTAKESConfig
extends Object
implements Serializable
```
Configuration for CTAKESContentHandler. This class allows to enable cTAKES and set its parameters.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

CTAKESConfig()
Default constructor.

CTAKESConfig(InputStream stream)
Loads properties from InputStream and then tries to close InputStream.

Constructors
Constructor and Description
`CTAKESConfig()` Default constructor.
`CTAKESConfig(InputStream stream)` Loads properties from InputStream and then tries to close InputStream.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAeDescriptorPath()` Returns the path to XML descriptor for AnalysisEngine.
`CTAKESAnnotationProperty[]`	`getAnnotationProps()` Returns an array of `CTAKESAnnotationProperty`'s that will be included into cTAKES metadata.
`String`	`getAnnotationPropsAsString()` Returns a string containing a comma-separated list of `CTAKESAnnotationProperty` names that will be included into cTAKES metadata.
`String[]`	`getMetadata()` Returns an array of metadata whose values will be analyzed using cTAKES.
`String`	`getMetadataAsString()` Returns a string containing a comma-separated list of metadata whose values will be analyzed using cTAKES.
`OutputStream`	`getOutputStream()` Returns an `OutputStream` object used write the CAS.
`char`	`getSeparatorChar()` Returns the separator character used for annotation properties.
`CTAKESSerializer`	`getSerializerType()` Returns the type of cTAKES (UIMA) serializer used to write the CAS.
`String`	`getUMLSPass()` Returns the UMLS password.
`String`	`getUMLSUser()` Returns the UMLS username.
`boolean`	`isPrettyPrint()` Returns `true` if formatted output is enabled, `false` otherwise.
`boolean`	`isSerialize()` Returns `true` if CAS serialization is enabled, `false` otherwise.
`boolean`	`isText()` Returns `true` if content text analysis is enabled `false` otherwise.
`void`	`setAeDescriptorPath(String aeDescriptorPath)` Sets the path to XML descriptor for AnalysisEngine.
`void`	`setAnnotationProps(CTAKESAnnotationProperty[] annotationProps)` Sets the `CTAKESAnnotationProperty`'s that will be included into cTAKES metadata.
`void`	`setAnnotationProps(String[] annotationProps)` ets the `CTAKESAnnotationProperty`'s that will be included into cTAKES metadata.
`void`	`setMetadata(String[] metadata)` Sets the metadata whose values will be analyzed using cTAKES.
`void`	`setOutputStream(OutputStream stream)` Sets the `OutputStream` object used to write the CAS.
`void`	`setPrettyPrint(boolean prettyPrint)` Enables the formatted output for serializer.
`void`	`setSeparatorChar(char separatorChar)` Sets the separator character used for annotation properties.
`void`	`setSerialize(boolean serialize)` Enables CAS serialization.
`void`	`setSerializerType(CTAKESSerializer serializerType)` Sets the type of cTAKES (UIMA) serializer used to write CAS.
`void`	`setText(boolean text)` Enables content text analysis using cTAKES.
`void`	`setUMLSPass(String uMLSPass)` Sets the UMLS password.
`void`	`setUMLSUser(String uMLSUser)` Sets the UMLS username.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CTAKESConfig
```
public CTAKESConfig()
```
    Default constructor.
  - CTAKESConfig
```
public CTAKESConfig(InputStream stream)
```
    Loads properties from InputStream and then tries to close InputStream.
    
    Parameters:
    
    stream - InputStream object used to read properties.
- Method Detail
  - getAeDescriptorPath
```
public String getAeDescriptorPath()
```
    Returns the path to XML descriptor for AnalysisEngine.
    
    Returns:
    
    the path to XML descriptor for AnalysisEngine.
  - getUMLSUser
```
public String getUMLSUser()
```
    Returns the UMLS username.
    
    Returns:
    
    the UMLS username.
  - getUMLSPass
```
public String getUMLSPass()
```
    Returns the UMLS password.
    
    Returns:
    
    the UMLS password.
  - isPrettyPrint
```
public boolean isPrettyPrint()
```
    Returns true if formatted output is enabled, false otherwise.
    
    Returns:
    
    true if formatted output is enabled, false otherwise.
  - getSerializerType
```
public CTAKESSerializer getSerializerType()
```
    Returns the type of cTAKES (UIMA) serializer used to write the CAS.
    
    Returns:
    
    the type of cTAKES serializer.
  - getOutputStream
```
public OutputStream getOutputStream()
```
    Returns an OutputStream object used write the CAS.
    
    Returns:
    
    OutputStream object used write the CAS.
  - isSerialize
```
public boolean isSerialize()
```
    Returns true if CAS serialization is enabled, false otherwise.
    
    Returns:
    
    true if CAS serialization output is enabled, false otherwise.
  - isText
```
public boolean isText()
```
    Returns true if content text analysis is enabled false otherwise.
    
    Returns:
    
    true if content text analysis is enabled false otherwise.
  - getMetadata
```
public String[] getMetadata()
```
    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()
```
    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()
```
    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()
```
    Returns a string containing a comma-separated list of CTAKESAnnotationProperty names that will be included into cTAKES metadata.
    
    Returns:
  - getSeparatorChar
```
public char getSeparatorChar()
```
    Returns the separator character used for annotation properties.
    
    Returns:
    
    the separator character used for annotation properties.
  - setAeDescriptorPath
```
public void setAeDescriptorPath(String aeDescriptorPath)
```
    Sets the path to XML descriptor for AnalysisEngine.
    
    Parameters:
    
    aeDescriptorPath - the path to XML descriptor for AnalysisEngine.
  - setUMLSUser
```
public void setUMLSUser(String uMLSUser)
```
    Sets the UMLS username.
    
    Parameters:
    
    uMLSUser - the UMLS username.
  - setUMLSPass
```
public void setUMLSPass(String uMLSPass)
```
    Sets the UMLS password.
    
    Parameters:
    
    uMLSPass - the UMLS password.
  - setPrettyPrint
```
public void setPrettyPrint(boolean prettyPrint)
```
    Enables the formatted output for serializer.
    
    Parameters:
    
    prettyPrint - to enable formatted output, false otherwise.
  - setSerializerType
```
public void setSerializerType(CTAKESSerializer serializerType)
```
    Sets the type of cTAKES (UIMA) serializer used to write CAS.
    
    Parameters:
    
    serializerType - the type of cTAKES serializer.
  - setOutputStream
```
public void setOutputStream(OutputStream stream)
```
    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)
```
    Enables CAS serialization.
    
    Parameters:
    
    serialize - to enable CAS serialization, false otherwise.
  - setText
```
public void setText(boolean text)
```
    Enables content text analysis using cTAKES.
    
    Parameters:
    
    text - to enable content text analysis, false otherwise.
  - setMetadata
```
public void setMetadata(String[] metadata)
```
    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)
```
    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)
```
    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)
```
    Sets the separator character used for annotation properties.
    
    Parameters:
    
    separatorChar - the separator character used for annotation properties.

Class CTAKESConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CTAKESConfig

CTAKESConfig

Method Detail

getAeDescriptorPath

getUMLSUser

getUMLSPass

isPrettyPrint

getSerializerType

getOutputStream

isSerialize

isText

getMetadata

getMetadataAsString

getAnnotationProps

getAnnotationPropsAsString

getSeparatorChar

setAeDescriptorPath

setUMLSUser

setUMLSPass

setPrettyPrint

setSerializerType

setOutputStream

setSerialize

setText

setMetadata

setAnnotationProps

setAnnotationProps

setSeparatorChar