ConditionalParameters (Okapi Framework SDK 0.38 API)

java.lang.Object
- net.sf.okapi.common.BaseParameters
- - net.sf.okapi.common.StringParameters
  - - net.sf.okapi.filters.openxml.ConditionalParameters

All Implemented Interfaces:: IParameters

public class ConditionalParameters
extends StringParameters

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`MSWORD`
`ParseType`	`nFileType`
`TreeSet<String>`	`tsComplexFieldDefinitionsToExtract`
`TreeSet<String>`	`tsExcelExcludedColors`
`TreeSet<String>`	`tsExcelExcludedColumns`
`TreeSet<String>`	`tsExcludeWordStyles`
`TreeSet<Integer>`	`tsPowerpointIncludedSlideNumbers` Slide numbers of those slides that should be extracted.
`TreeSet<String>`	`tsWordExcludedColors`
`TreeSet<String>`	`tsWordHighlightColors`

Fields inherited from class net.sf.okapi.common.StringParameters
buffer

Fields inherited from class net.sf.okapi.common.BaseParameters
path

Constructor Summary

Constructors
Constructor and Description

ConditionalParameters()

Constructors
Constructor and Description
`ConditionalParameters()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ConditionalParameters`	`clone()`
`Set<String>`	`findExcludedColumnsForSheetNumber(int sheetNumber)` Extract the subset of the excluded columns that are relevant for this sheet.
`void`	`fromString(String data)` Reset this parameters object to its default values and then load additional parameters from the provided data.
`boolean`	`getAddLineSeparatorCharacter()`
`boolean`	`getAddTabAsCharacter()`
`boolean`	`getAutomaticallyAcceptRevisions()`
`boolean`	`getCleanupAggressively()`
`boolean`	`getExtractExternalHyperlinks()`
`boolean`	`getIgnorePlaceholdersInPowerpointMasters()`
`boolean`	`getIgnoreSoftHyphenTag()`
`char`	`getLineSeparatorReplacement()`
`boolean`	`getPowerpointIncludedSlideNumbersOnly()`
`boolean`	`getReorderPowerpointNotesAndComments()`
`boolean`	`getReplaceNoBreakHyphenTag()`
`String`	`getSubfilter()`
`boolean`	`getTranslateComments()`
`boolean`	`getTranslateDocProperties()`
`boolean`	`getTranslateExcelDiagramData()`
`boolean`	`getTranslateExcelDrawings()`
`boolean`	`getTranslateExcelExcludeColors()`
`boolean`	`getTranslateExcelExcludeColumns()`
`boolean`	`getTranslateExcelHidden()` Return true if we should translate hidden cells and columns, false (default) if we should not.
`boolean`	`getTranslateExcelSheetNames()`
`boolean`	`getTranslatePowerpointHidden()`
`boolean`	`getTranslatePowerpointMasters()`
`boolean`	`getTranslatePowerpointNotes()`
`boolean`	`getTranslateWordExcludeColors()`
`boolean`	`getTranslateWordExcludeGraphicMetaData()`
`boolean`	`getTranslateWordHeadersFooters()`
`boolean`	`getTranslateWordHidden()`
`boolean`	`getTranslateWordInExcludeHighlightMode()`
`boolean`	`getTranslateWordInExcludeStyleMode()`
`void`	`load(URI inputURI, boolean p_bIgnoreErrors)`
`void`	`reset()` Reset this parameters object to its default values.
`void`	`save(String newPath)` Saves the parameters to a file.
`void`	`setAddLineSeparatorCharacter(boolean bAddLineSeparatorAsCharacter)`
`void`	`setAddTabAsCharacter(boolean bAddTabAsCharacter)`
`void`	`setAutomaticallyAcceptRevisions(boolean automaticallyAcceptRevisions)`
`void`	`setCleanupAggressively(boolean aggressiveCleanup)`
`void`	`setExtractExternalHyperlinks(boolean bExtractExternalHyperlinks)`
`void`	`setIgnorePlaceholdersInPowerpointMasters(boolean ignorePlaceholdersInPowerpointMasters)`
`void`	`setIgnoreSoftHyphenTag(boolean bIgnoreSoftHyphenTag)`
`void`	`setLineSeparatorReplacement(char lineSeparatorReplacement)`
`void`	`setPowerpointIncludedSlideNumbersOnly(boolean bIncludedSlideNumbersOnly)`
`void`	`setReorderPowerpointNotesAndComments(boolean reorderPowerpointNotesAndComments)`
`void`	`setReplaceNoBreakHyphenTag(boolean bReplaceNoBreakHyphenTag)`
`void`	`setSubfilter(String subfilter)`
`void`	`setTranslateComments(boolean translateComments)`
`void`	`setTranslateDocProperties(boolean translateDocProperties)`
`void`	`setTranslateExcelDiagramData(boolean translateExcelDiagramData)`
`void`	`setTranslateExcelDrawings(boolean translateExcelDrawings)`
`void`	`setTranslateExcelExcludeColors(boolean translateExcelExcludeColors)`
`void`	`setTranslateExcelExcludeColumns(boolean translateExcelExcludeColumns)`
`void`	`setTranslateExcelHidden(boolean translateExcelHidden)`
`void`	`setTranslateExcelSheetNames(boolean translateExcelSheetNames)`
`void`	`setTranslatePowerpointHidden(boolean translatePowerpointHidden)`
`void`	`setTranslatePowerpointMasters(boolean translatePowerpointMasters)`
`void`	`setTranslatePowerpointNotes(boolean translatePowerpointNotes)`
`void`	`setTranslateWordExcludeColors(boolean translateWordExcludeColors)`
`void`	`setTranslateWordExcludeGraphicMetaData(boolean excludeGraphicMetaData)`
`void`	`setTranslateWordHeadersFooters(boolean translateWordHeadersFooters)`
`void`	`setTranslateWordHidden(boolean translateWordHidden)`
`void`	`setTranslateWordInExcludeHighlightMode(boolean inExcludeHighlightMode)`
`void`	`setTranslateWordInExcludeStyleMode(boolean inExcludeMode)`
`String`	`toString()` Serialize this parameters object to a string.

Methods inherited from class net.sf.okapi.common.StringParameters
fromString, getBoolean, getGroup, getInteger, getString, setBoolean, setGroup, setInteger, setString

Methods inherited from class net.sf.okapi.common.BaseParameters
getParametersDescription, getPath, load, load, setPath

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

- Field Detail
  - MSWORD
```
public static final int MSWORD
```
    See Also:
    
    Constant Field Values
  - tsComplexFieldDefinitionsToExtract
```
public TreeSet<String> tsComplexFieldDefinitionsToExtract
```
  - tsExcelExcludedColors
```
public TreeSet<String> tsExcelExcludedColors
```
  - tsExcelExcludedColumns
```
public TreeSet<String> tsExcelExcludedColumns
```
  - 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.
  - nFileType
```
public ParseType nFileType
```
- Constructor Detail
  - ConditionalParameters
```
public ConditionalParameters()
```
- Method Detail
  - getTranslateDocProperties
```
public boolean getTranslateDocProperties()
```
  - setTranslateDocProperties
```
public void setTranslateDocProperties(boolean translateDocProperties)
```
  - getTranslateComments
```
public boolean getTranslateComments()
```
  - setTranslateComments
```
public void setTranslateComments(boolean translateComments)
```
  - 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)
```
  - 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)
```
  - 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)
```
  - getTranslateExcelExcludeColumns
```
public boolean getTranslateExcelExcludeColumns()
```
  - setTranslateExcelExcludeColumns
```
public void setTranslateExcelExcludeColumns(boolean translateExcelExcludeColumns)
```
  - getTranslateExcelSheetNames
```
public boolean getTranslateExcelSheetNames()
```
  - setTranslateExcelSheetNames
```
public void setTranslateExcelSheetNames(boolean translateExcelSheetNames)
```
  - 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)
```
  - getReorderPowerpointNotesAndComments
```
public boolean getReorderPowerpointNotesAndComments()
```
  - setReorderPowerpointNotesAndComments
```
public void setReorderPowerpointNotesAndComments(boolean reorderPowerpointNotesAndComments)
```
  - 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)
```
  - clone
```
public ConditionalParameters clone()
```
    Overrides:
    
    clone in class Object
  - findExcludedColumnsForSheetNumber
```
public Set<String> findExcludedColumnsForSheetNumber(int sheetNumber)
```
    Extract the subset of the excluded columns that are relevant for this sheet. Strip the numerical prefix and just return a set of column names. The column excludes are stored as a set of patterns "NX", where - N = 1, 2, or 3, corresponding to "1st sheet", "2nd sheet", and "3rd+ sheet" - X = a column identified ("A", "BB", etc)
    
    Parameters:
    
    sheetNumber - the sheet number to extract
    
    Returns:
    
    all the subset of the excluded columns that are relevant for this sheet

Class ConditionalParameters

Field Summary

Fields inherited from class net.sf.okapi.common.StringParameters

Fields inherited from class net.sf.okapi.common.BaseParameters

Constructor Summary

Method Summary

Methods inherited from class net.sf.okapi.common.StringParameters

Methods inherited from class net.sf.okapi.common.BaseParameters

Methods inherited from class java.lang.Object

Field Detail

MSWORD

tsComplexFieldDefinitionsToExtract

tsExcelExcludedColors

tsExcelExcludedColumns

tsExcludeWordStyles

tsWordHighlightColors

tsWordExcludedColors

tsPowerpointIncludedSlideNumbers

nFileType

Constructor Detail

ConditionalParameters

Method Detail

getTranslateDocProperties

setTranslateDocProperties

getTranslateComments

setTranslateComments

getCleanupAggressively

setCleanupAggressively

getAutomaticallyAcceptRevisions

setAutomaticallyAcceptRevisions

getTranslatePowerpointNotes

setTranslatePowerpointNotes

getTranslatePowerpointMasters

setTranslatePowerpointMasters

setIgnorePlaceholdersInPowerpointMasters

getIgnorePlaceholdersInPowerpointMasters

getTranslateWordHeadersFooters

setTranslateWordHeadersFooters

getTranslateWordHidden

setTranslateWordHidden

getTranslatePowerpointHidden

setTranslatePowerpointHidden

getTranslateExcelHidden

setTranslateExcelHidden

getTranslateExcelExcludeColors

setTranslateExcelExcludeColors

getTranslateExcelExcludeColumns

setTranslateExcelExcludeColumns

getTranslateExcelSheetNames

setTranslateExcelSheetNames

getTranslateExcelDiagramData

setTranslateExcelDiagramData

getTranslateExcelDrawings

setTranslateExcelDrawings

getTranslateWordExcludeGraphicMetaData

setTranslateWordExcludeGraphicMetaData

getAddTabAsCharacter

setAddTabAsCharacter

getAddLineSeparatorCharacter

setAddLineSeparatorCharacter

getLineSeparatorReplacement

setLineSeparatorReplacement

getReplaceNoBreakHyphenTag

setReplaceNoBreakHyphenTag

getIgnoreSoftHyphenTag

setIgnoreSoftHyphenTag

setExtractExternalHyperlinks

getExtractExternalHyperlinks

setPowerpointIncludedSlideNumbersOnly

getPowerpointIncludedSlideNumbersOnly

getTranslateWordInExcludeStyleMode

setTranslateWordInExcludeStyleMode

getTranslateWordInExcludeHighlightMode

setTranslateWordInExcludeHighlightMode

getTranslateWordExcludeColors

setTranslateWordExcludeColors

getReorderPowerpointNotesAndComments

setReorderPowerpointNotesAndComments

getSubfilter

setSubfilter