Package net.sf.okapi.filters.pdf
Class Parameters
- java.lang.Object
-
- net.sf.okapi.common.BaseParameters
-
- net.sf.okapi.common.StringParameters
-
- net.sf.okapi.filters.pdf.Parameters
-
- All Implemented Interfaces:
IParameters,ISimplifierRulesParameters,IEditorDescriptionProvider
public class Parameters extends StringParameters implements IEditorDescriptionProvider, ISimplifierRulesParameters
-
-
Field Summary
Fields Modifier and Type Field Description InlineCodeFindercodeFinderstatic StringINDENT_THRESHOLDstatic StringLINE_SEPARATORstatic StringPARAGRAPH_SEPARATORstatic StringPRESERVE_WHITESPACEstatic StringSPACING_TOLERANCEstatic StringUSECODEFINDER-
Fields inherited from class net.sf.okapi.common.StringParameters
buffer
-
Fields inherited from class net.sf.okapi.common.BaseParameters
path
-
Fields inherited from interface net.sf.okapi.common.ISimplifierRulesParameters
SIMPLIFIERRULES, SIMPLIFIERRULES_DISPLAY_NAME, SIMPLIFIERRULES_SHORT_DESC
-
-
Constructor Summary
Constructors Constructor Description Parameters()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EditorDescriptioncreateEditorDescription(ParametersDescription paramsDesc)voidfromString(String data)Reset this parameters object to its default values and then load additional parameters from the provided data.StringgetIndentThreshold()StringgetLineSeparator()StringgetParagraphSeparator()ParametersDescriptiongetParametersDescription()Gets the description of the parameters.booleangetPreserveWhitespace()StringgetSimplifierRules()Get the code simplifier rules as defined bySimplifierRules(JavaCC file: core/simplifierrules/SimplifierRules.jj).StringgetSpacingTolerance()booleangetUseCodeFinder()voidreset()Reset this parameters object to its default values.voidsetIndentThreshold(String value)voidsetLineSeparator(String value)voidsetParagraphSeparator(String value)voidsetPreserveWhitespace(boolean preserve)voidsetSimplifierRules(String rules)Set the simplifier rules.voidsetSpacingTolerance(String value)voidsetUseCodeFinder(boolean useCodeFinder)StringtoString()Serialize this parameters object to a string.voidvalidateSimplifierRules()Validate the current code simplifier rules.-
Methods inherited from class net.sf.okapi.common.StringParameters
fromString, getBoolean, getGroup, getInteger, getString, setBoolean, setGroup, setInteger, setString
-
-
-
-
Field Detail
-
USECODEFINDER
public static final String USECODEFINDER
- See Also:
- Constant Field Values
-
INDENT_THRESHOLD
public static final String INDENT_THRESHOLD
- See Also:
- Constant Field Values
-
SPACING_TOLERANCE
public static final String SPACING_TOLERANCE
- See Also:
- Constant Field Values
-
PRESERVE_WHITESPACE
public static final String PRESERVE_WHITESPACE
- See Also:
- Constant Field Values
-
LINE_SEPARATOR
public static final String LINE_SEPARATOR
- See Also:
- Constant Field Values
-
PARAGRAPH_SEPARATOR
public static final String PARAGRAPH_SEPARATOR
- See Also:
- Constant Field Values
-
codeFinder
public InlineCodeFinder codeFinder
-
-
Method Detail
-
getUseCodeFinder
public boolean getUseCodeFinder()
-
setUseCodeFinder
public void setUseCodeFinder(boolean useCodeFinder)
-
setIndentThreshold
public void setIndentThreshold(String value)
-
getIndentThreshold
public String getIndentThreshold()
-
setSpacingTolerance
public void setSpacingTolerance(String value)
-
getSpacingTolerance
public String getSpacingTolerance()
-
setPreserveWhitespace
public void setPreserveWhitespace(boolean preserve)
-
getPreserveWhitespace
public boolean getPreserveWhitespace()
-
getLineSeparator
public String getLineSeparator()
-
setLineSeparator
public void setLineSeparator(String value)
-
getParagraphSeparator
public String getParagraphSeparator()
-
setParagraphSeparator
public void setParagraphSeparator(String value)
-
reset
public void reset()
Description copied from class:StringParametersReset 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:
resetin interfaceIParameters- Overrides:
resetin classStringParameters
-
toString
public String toString()
Description copied from class:StringParametersSerialize 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:
toStringin interfaceIParameters- Overrides:
toStringin classStringParameters- Returns:
- the string holding all the parameters.
-
fromString
public void fromString(String data)
Description copied from class:StringParametersReset 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:
fromStringin interfaceIParameters- Overrides:
fromStringin classStringParameters- 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.
-
getSimplifierRules
public String getSimplifierRules()
Description copied from interface:ISimplifierRulesParametersGet the code simplifier rules as defined bySimplifierRules(JavaCC file: core/simplifierrules/SimplifierRules.jj).- Specified by:
getSimplifierRulesin interfaceISimplifierRulesParameters- Returns:
- rules as a string.
-
setSimplifierRules
public void setSimplifierRules(String rules)
Description copied from interface:ISimplifierRulesParametersSet the simplifier rules.- Specified by:
setSimplifierRulesin interfaceISimplifierRulesParameters- Parameters:
rules- new simplifier rules
-
validateSimplifierRules
public void validateSimplifierRules() throws ParseExceptionDescription copied from interface:ISimplifierRulesParametersValidate the current code simplifier rules.- Specified by:
validateSimplifierRulesin interfaceISimplifierRulesParameters- Throws:
ParseException- if the rule cannot be parsed
-
getParametersDescription
public ParametersDescription getParametersDescription()
Description copied from interface:IParametersGets the description of the parameters.- Specified by:
getParametersDescriptionin interfaceIParameters- Overrides:
getParametersDescriptionin classBaseParameters- Returns:
- the ParametersDescription object for this set of parameters, or null if none is provided.
-
createEditorDescription
public EditorDescription createEditorDescription(ParametersDescription paramsDesc)
- Specified by:
createEditorDescriptionin interfaceIEditorDescriptionProvider
-
-