Package edu.upf.taln.dri.lib.util

Class ModuleConfig

  • public class ModuleConfig
extends Object
    Class to configure how a scientific publication will be processed by the Dr. Inventor Text Mining Framework.
    IMPORTANT: this configuration should be set up before initializing the Dr. Inventor Text Mining Framework!
    The Framework integrates a set of scientific text mining modules; each module is responsible to perform a set of analyses of scientific publications.
    By means of this class it is possible to selectively enable only the module of interest for each particular use case, thus performing the analyses of scientific publications that the user actually needs. The following modules of the Dr. Inventor Text Mining Framework can be selectively enabled or disabled:
    - BibEntryParsing: enriches each bibliographic entry of the paper by retrieving cited paper's meta-data from Bibsonomy, CrossRef and FreeCite;
    - HeaderParsing: parse the contents of the header of the paper by means of external Web Services;
    - BabelNetParsing: disambiguate the textual contents of the paper by means of BabelNet;
    - TerminologyParsing: spot candidate terms inside the paper;
    - GraphParsing: perform the dependency parsing of the contents of the paper, thus enabling the extraction of Subject-Verb-Object graphs;
    - RhetoricalClassification: identify for each sentence of the paper, its rhetorical category (Background, Approach, Outcome, FutureWirk, Challenge);
    - CoreferenceResolution: perform co-reference resolution;
    - CausalityParsing: extract causal relations from the paper;
    - MetaAnnotationsParsing: extract
    - MultiLangSupport (Experimental): for multi-language papers - detect the language of each text excerpt of the paper and analyze it only if English. Specific post-processing modules are available to analyze the textual contents of papers in languages different than english: see package postproc


    See http://driframework.readthedocs.io/en/latest/Initialize/ to obtain more information on how to configure (enable / disable) the modules of the Dr. Inventor Text Mining Framework.

    Remember that if you disable a specific module, the related information fields in the instances of the data model objects will be set to null.
    For instance if you set enableRhetoricalClassification to false, the rhetorical class is not identified and thus not assigned to the sentences of the paper and the related field of the Sentence class, retrieved by means of the method Sentence#getRhetoricalClass() will return a null or STILL_NOT_EXECUTED_RHETORICAL_CLASSIFICATION value.

    Author:
    francesco

    • Constructor Detail

      • ModuleConfig

        public ModuleConfig()
        The constructor set by default all modules enabled.

    • Method Detail

      • isEnableBibEntryParsing

        public boolean isEnableBibEntryParsing()

      • setEnableBibEntryParsing

        public void setEnableBibEntryParsing​(boolean enableBibEntryParsing)

      • isEnableHeaderParsing

        public boolean isEnableHeaderParsing()

      • setEnableHeaderParsing

        public void setEnableHeaderParsing​(boolean enableHeaderParsing)

      • isEnableBabelNetParsing

        public boolean isEnableBabelNetParsing()

      • setEnableBabelNetParsing

        public void setEnableBabelNetParsing​(boolean enableBabelNetParsing)

      • isEnableTerminologyParsing

        public boolean isEnableTerminologyParsing()

      • isEnableMetaAnnotationsParsing

        public boolean isEnableMetaAnnotationsParsing()

      • setEnableMetaAnnotationsParsing

        public void setEnableMetaAnnotationsParsing​(boolean enableMetaAnnotationsParsing)
        If you enable meta-annotation extraction, also the graph parsing will be enabled if not since is a prerequisite for meta-annotation extraction
        Parameters:
        enableMetaAnnotationsParsing -

      • setEnableTerminologyParsing

        public void setEnableTerminologyParsing​(boolean enableTerminologyParsing)

      • isEnableGraphParsing

        public boolean isEnableGraphParsing()

      • isEnableMultiLangSupport

        public boolean isEnableMultiLangSupport()

      • setEnableMultiLangSupport

        public void setEnableMultiLangSupport​(boolean enableSentenceLanguageDetection)

      • setEnableGraphParsing

        public void setEnableGraphParsing​(boolean enableGraphParsing)
        IMPORTANT: when you disable the graph parsing, you also disable at the same time the causality parsing, the coreference resolution and the rhetorical classification since they are all based on graph parsing results.
        Parameters:
        enableGraphParsing -

      • isEnableRhetoricalClassification

        public boolean isEnableRhetoricalClassification()

      • setEnableRhetoricalClassification

        public void setEnableRhetoricalClassification​(boolean enableRhetoricalClassification)
        If you enable rhetorical classification, also the graph parsing will be enabled if not since is a prerequisite for rhetorical classification
        Parameters:
        enableRhetoricalClassification -

      • isEnableCoreferenceResolution

        public boolean isEnableCoreferenceResolution()

      • setEnableCoreferenceResolution

        public void setEnableCoreferenceResolution​(boolean enableCoreferenceResolution)
        If you enable coreference resolution, also the graph parsing will be enabled if not since is a prerequisite for coreference resolution
        Parameters:
        enableCoreferenceResolution -

      • isEnableCausalityParsing

        public boolean isEnableCausalityParsing()

      • setEnableCausalityParsing

        public void setEnableCausalityParsing​(boolean enableCausalityParsing)
        If you enable causality parsing, also the graph parsing will be enabled if not since is a prerequisite for causality parsing
        Parameters:
        enableCausalityParsing -