Package org.apache.tika.parser.ctakes

Class CTAKESConfig

  • All Implemented Interfaces:
    java.io.Serializable
    public class CTAKESConfig
extends java.lang.Object
implements java.io.Serializable
    Configuration for CTAKESContentHandler. This class allows to enable cTAKES and set its parameters.
    See Also:
    Serialized Form

    • Constructor Detail

      • CTAKESConfig

        public CTAKESConfig()
        Default constructor.

      • CTAKESConfig

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

    • Method Detail

      • getAeDescriptorPath

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

      • getUMLSUser

        public java.lang.String getUMLSUser()
        Returns the UMLS username.
        Returns:
        the UMLS username.

      • getUMLSPass

        public java.lang.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 java.io.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 java.lang.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 java.lang.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.

      • getAnnotationPropsAsString

        public java.lang.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​(java.lang.String aeDescriptorPath)
        Sets the path to XML descriptor for AnalysisEngine.
        Parameters:
        aeDescriptorPath - the path to XML descriptor for AnalysisEngine.

      • setUMLSUser

        public void setUMLSUser​(java.lang.String uMLSUser)
        Sets the UMLS username.
        Parameters:
        uMLSUser - the UMLS username.

      • setUMLSPass

        public void setUMLSPass​(java.lang.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 - true 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​(java.io.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 - true to enable CAS serialization, false otherwise.

      • setText

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

      • setMetadata

        public void setMetadata​(java.lang.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​(java.lang.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.