Class ConditionalParameters

    • Field Detail

      • tsComplexFieldDefinitionsToExtract

        public TreeSet<String> tsComplexFieldDefinitionsToExtract
      • tsExcelExcludedColors

        public TreeSet<String> tsExcelExcludedColors
      • tsExcludeWordStyles

        public TreeSet<String> tsExcludeWordStyles
      • tsWordHighlightColors

        public TreeSet<String> tsWordHighlightColors
      • tsWordExcludedColors

        public TreeSet<String> tsWordExcludedColors
      • tsPowerpointIncludedSlideNumbers

        public TreeSet<Integer> tsPowerpointIncludedSlideNumbers
        Slide numbers of those slides that should be extracted. The set is 1-based (not 0-based) for better readability, i.e. 1 ist the first slide. Only considered if POWERPOINT_INCLUDED_SLIDE_NUMBERS_ONLY was set to true.
    • Constructor Detail

      • ConditionalParameters

        public ConditionalParameters()
    • Method Detail

      • getMaxAttributeSize

        public int getMaxAttributeSize()
      • setMaxAttributeSize

        public void setMaxAttributeSize​(int maxAttributeSize)
      • getTranslateDocProperties

        public boolean getTranslateDocProperties()
      • setTranslateDocProperties

        public void setTranslateDocProperties​(boolean translateDocProperties)
      • getTranslatePowerpointDocProperties

        public boolean getTranslatePowerpointDocProperties()
      • setTranslatePowerpointDocProperties

        public void setTranslatePowerpointDocProperties​(boolean value)
      • getReorderPowerpointDocProperties

        public boolean getReorderPowerpointDocProperties()
      • setReorderPowerpointDocProperties

        public void setReorderPowerpointDocProperties​(boolean value)
      • setReorderPowerpointRelationships

        public void setReorderPowerpointRelationships​(boolean value)
      • getReorderPowerpointRelationships

        public boolean getReorderPowerpointRelationships()
      • getTranslatePowerpointDiagramData

        public boolean getTranslatePowerpointDiagramData()
      • setTranslatePowerpointDiagramData

        public void setTranslatePowerpointDiagramData​(boolean value)
      • getReorderPowerpointDiagramData

        public boolean getReorderPowerpointDiagramData()
      • setReorderPowerpointDiagramData

        public void setReorderPowerpointDiagramData​(boolean value)
      • getTranslatePowerpointCharts

        public boolean getTranslatePowerpointCharts()
      • setTranslatePowerpointCharts

        public void setTranslatePowerpointCharts​(boolean value)
      • getReorderPowerpointCharts

        public boolean getReorderPowerpointCharts()
      • setReorderPowerpointCharts

        public void setReorderPowerpointCharts​(boolean value)
      • getTranslateComments

        public boolean getTranslateComments()
      • setTranslateComments

        public void setTranslateComments​(boolean translateComments)
      • getTranslatePowerpointComments

        public boolean getTranslatePowerpointComments()
      • setTranslatePowerpointComments

        public void setTranslatePowerpointComments​(boolean value)
      • getReorderPowerpointComments

        public boolean getReorderPowerpointComments()
      • setReorderPowerpointComments

        public void setReorderPowerpointComments​(boolean value)
      • getCleanupAggressively

        public boolean getCleanupAggressively()
      • setCleanupAggressively

        public void setCleanupAggressively​(boolean aggressiveCleanup)
      • getAutomaticallyAcceptRevisions

        public boolean getAutomaticallyAcceptRevisions()
      • setAutomaticallyAcceptRevisions

        public void setAutomaticallyAcceptRevisions​(boolean automaticallyAcceptRevisions)
      • getTranslatePowerpointNotes

        public boolean getTranslatePowerpointNotes()
      • setTranslatePowerpointNotes

        public void setTranslatePowerpointNotes​(boolean translatePowerpointNotes)
      • getReorderPowerpointNotes

        public boolean getReorderPowerpointNotes()
      • setReorderPowerpointNotes

        public void setReorderPowerpointNotes​(boolean value)
      • getTranslatePowerpointMasters

        public boolean getTranslatePowerpointMasters()
      • setTranslatePowerpointMasters

        public void setTranslatePowerpointMasters​(boolean translatePowerpointMasters)
      • setIgnorePlaceholdersInPowerpointMasters

        public void setIgnorePlaceholdersInPowerpointMasters​(boolean ignorePlaceholdersInPowerpointMasters)
      • getIgnorePlaceholdersInPowerpointMasters

        public boolean getIgnorePlaceholdersInPowerpointMasters()
      • getTranslateWordHeadersFooters

        public boolean getTranslateWordHeadersFooters()
      • setTranslateWordHeadersFooters

        public void setTranslateWordHeadersFooters​(boolean translateWordHeadersFooters)
      • setTranslateWordNumberingLevelText

        public void setTranslateWordNumberingLevelText​(boolean value)
      • getTranslateWordNumberingLevelText

        public boolean getTranslateWordNumberingLevelText()
      • getTranslateWordHidden

        public boolean getTranslateWordHidden()
      • setTranslateWordHidden

        public void setTranslateWordHidden​(boolean translateWordHidden)
      • getTranslatePowerpointHidden

        public boolean getTranslatePowerpointHidden()
      • setTranslatePowerpointHidden

        public void setTranslatePowerpointHidden​(boolean translatePowerpointHidden)
      • getTranslateExcelHidden

        public boolean getTranslateExcelHidden()
        Return true if we should translate hidden cells and columns, false (default) if we should not. Note that this setting has no affect on cells that are excluded from translation due to color or by column name in the configuration.
        Returns:
        true if we should translate hidden cells and columns
      • setTranslateExcelHidden

        public void setTranslateExcelHidden​(boolean translateExcelHidden)
      • getTranslateExcelExcludeColors

        public boolean getTranslateExcelExcludeColors()
      • setTranslateExcelExcludeColors

        public void setTranslateExcelExcludeColors​(boolean translateExcelExcludeColors)
      • getTranslateExcelSheetNames

        public boolean getTranslateExcelSheetNames()
      • setTranslateExcelSheetNames

        public void setTranslateExcelSheetNames​(boolean translateExcelSheetNames)
      • getTranslateExcelCellsCopied

        public boolean getTranslateExcelCellsCopied()
      • setTranslateExcelCellsCopied

        public void setTranslateExcelCellsCopied​(boolean value)
      • getTranslateExcelDiagramData

        public boolean getTranslateExcelDiagramData()
      • setTranslateExcelDiagramData

        public void setTranslateExcelDiagramData​(boolean translateExcelDiagramData)
      • getTranslateExcelDrawings

        public boolean getTranslateExcelDrawings()
      • setTranslateExcelDrawings

        public void setTranslateExcelDrawings​(boolean translateExcelDrawings)
      • getTranslateWordExcludeGraphicMetaData

        public boolean getTranslateWordExcludeGraphicMetaData()
      • setTranslateWordExcludeGraphicMetaData

        public void setTranslateWordExcludeGraphicMetaData​(boolean excludeGraphicMetaData)
      • getAddTabAsCharacter

        public boolean getAddTabAsCharacter()
      • setAddTabAsCharacter

        public void setAddTabAsCharacter​(boolean bAddTabAsCharacter)
      • getAddLineSeparatorCharacter

        public boolean getAddLineSeparatorCharacter()
      • setAddLineSeparatorCharacter

        public void setAddLineSeparatorCharacter​(boolean bAddLineSeparatorAsCharacter)
      • getLineSeparatorReplacement

        public char getLineSeparatorReplacement()
      • setLineSeparatorReplacement

        public void setLineSeparatorReplacement​(char lineSeparatorReplacement)
      • getReplaceNoBreakHyphenTag

        public boolean getReplaceNoBreakHyphenTag()
      • setReplaceNoBreakHyphenTag

        public void setReplaceNoBreakHyphenTag​(boolean bReplaceNoBreakHyphenTag)
      • getIgnoreSoftHyphenTag

        public boolean getIgnoreSoftHyphenTag()
      • setIgnoreSoftHyphenTag

        public void setIgnoreSoftHyphenTag​(boolean bIgnoreSoftHyphenTag)
      • setExtractExternalHyperlinks

        public void setExtractExternalHyperlinks​(boolean bExtractExternalHyperlinks)
      • getExtractExternalHyperlinks

        public boolean getExtractExternalHyperlinks()
      • setPowerpointIncludedSlideNumbersOnly

        public void setPowerpointIncludedSlideNumbersOnly​(boolean bIncludedSlideNumbersOnly)
      • getPowerpointIncludedSlideNumbersOnly

        public boolean getPowerpointIncludedSlideNumbersOnly()
      • getTranslateWordInExcludeStyleMode

        public boolean getTranslateWordInExcludeStyleMode()
      • setTranslateWordInExcludeStyleMode

        public void setTranslateWordInExcludeStyleMode​(boolean inExcludeMode)
      • getTranslateWordInExcludeHighlightMode

        public boolean getTranslateWordInExcludeHighlightMode()
      • setTranslateWordInExcludeHighlightMode

        public void setTranslateWordInExcludeHighlightMode​(boolean inExcludeHighlightMode)
      • getTranslateWordExcludeColors

        public boolean getTranslateWordExcludeColors()
      • setTranslateWordExcludeColors

        public void setTranslateWordExcludeColors​(boolean translateWordExcludeColors)
      • getIgnoreWordFontColors

        public boolean getIgnoreWordFontColors()
      • setIgnoreWordFontColors

        public void setIgnoreWordFontColors​(boolean value)
      • getWordFontColorsMinIgnoranceThreshold

        public String getWordFontColorsMinIgnoranceThreshold()
      • setWordFontColorsMinIgnoranceThreshold

        public void setWordFontColorsMinIgnoranceThreshold​(String value)
      • getWordFontColorsMaxIgnoranceThreshold

        public String getWordFontColorsMaxIgnoranceThreshold()
      • setWordFontColorsMaxIgnoranceThreshold

        public void setWordFontColorsMaxIgnoranceThreshold​(String value)
      • getAllowWordStyleOptimisation

        public boolean getAllowWordStyleOptimisation()
      • setAllowWordStyleOptimisation

        public void setAllowWordStyleOptimisation​(boolean value)
      • getPreserveExcelStylesInTargetColumns

        public boolean getPreserveExcelStylesInTargetColumns()
      • setPreserveExcelStylesInTargetColumns

        public void setPreserveExcelStylesInTargetColumns​(boolean value)
      • getAllowEmptyTargets

        public boolean getAllowEmptyTargets()
      • setAllowEmptyTargets

        public void setAllowEmptyTargets​(boolean useSourceForEmptyTarget)
      • getSubfilter

        public String getSubfilter()
      • setSubfilter

        public void setSubfilter​(String subfilter)
      • reset

        public void reset()
        Description copied from class: StringParameters
        Reset this parameters object to its default values.

        Subclasses should override this method to set any initial values and instantiate any objects that require allocation. It is recommended that subclasses also call super.reset() in the override to ensure that the buffer is empty.

        Specified by:
        reset in interface IParameters
        Overrides:
        reset in class StringParameters
      • fromString

        public void fromString​(String data)
        Description copied from class: StringParameters
        Reset this parameters object to its default values and then load additional parameters from the provided data.

        Subclasses should not normally need to override this method unless they are maintaining complex values (eg, InlineCodeFinder) that require extra initialization as part of their parameter state.

        Specified by:
        fromString in interface IParameters
        Overrides:
        fromString in class StringParameters
        Parameters:
        data - the string holding the parameters. It must be formatted as the string generated by toString(). Line-breaks must be normalized to '\n'. It can also be null or empty, in such case the parameters are left with their current values. Use reset() to reset the parameters to their defaults.
      • toString

        public String toString()
        Description copied from class: StringParameters
        Serialize this parameters object to a string.

        Subclasses should not normally need to override this method unless they are maintaining complex values (eg, InlineCodeFinder) that require extra serialization as part of their parameter state.

        Specified by:
        toString in interface IParameters
        Overrides:
        toString in class StringParameters
        Returns:
        the string holding all the parameters.
      • save

        public void save​(String newPath)
        Description copied from interface: IParameters
        Saves the parameters to a file.
        Specified by:
        save in interface IParameters
        Overrides:
        save in class BaseParameters
        Parameters:
        newPath - the full path of the parameters file to save.
      • load

        public void load​(URI inputURI,
                         boolean p_bIgnoreErrors)