Package net.sf.okapi.filters.json

Class Parameters

    • Constructor Detail

      • Parameters

        public Parameters()

    • Method Detail

      • getExtractStandalone

        public boolean getExtractStandalone()

      • setExtractStandalone

        public void setExtractStandalone​(boolean extractStandalone)

      • getExtractAllPairs

        public boolean getExtractAllPairs()

      • setExtractAllPairs

        public void setExtractAllPairs​(boolean extractAllPairs)

      • getExceptions

        public String getExceptions()

      • setExceptions

        public void setExceptions​(String exceptions)

      • getUseKeyAsName

        public boolean getUseKeyAsName()

      • setUseKeyAsName

        public void setUseKeyAsName​(boolean useKeyAsName)

      • getUseFullKeyPath

        public boolean getUseFullKeyPath()

      • setUseFullKeyPath

        public void setUseFullKeyPath​(boolean useFullKeyPath)

      • getUseLeadingSlashOnKeyPath

        public boolean getUseLeadingSlashOnKeyPath()

      • setUseLeadingSlashOnKeyPath

        public void setUseLeadingSlashOnKeyPath​(boolean useLeadingSlashOnKeyPath)

      • getEscapeForwardSlashes

        public boolean getEscapeForwardSlashes()

      • setEscapeForwardSlashes

        public void setEscapeForwardSlashes​(boolean escapeForwardSlashes)

      • getNoteRules

        public String getNoteRules()
        A regex representing keys whose values should be saved to appear as a <note> element in XLIFF.
        Returns:
        the regex, or "" (not null) if none.

      • setNoteRules

        public void setNoteRules​(String noteRules)
        Parameters:
        noteRules - regex, or "". It is trimmed before saving.
        See Also:
        getNoteRules()

      • getSubfilterRules

        public String getSubfilterRules()
        A regex representing keys whose values should be processed with the configured subfilter. If subfilter is specified and this parameter is empty, all values will be subfiltered. If this parameter is specified but subfilter is not, this parameter has no effect.
        Returns:
        the regex, or "" (not null) if none.

      • setSubfilterRules

        public void setSubfilterRules​(String subfilterRules)
        Parameters:
        subfilterRules - regex, or "". It is trimmed before saving.
        See Also:
        getSubfilterRules()

      • getExtractionRules

        public String getExtractionRules()
        A regex representing extraction rules (matching keys or key paths values are extracted)
        Returns:
        the regex, or "" (not null) if none.

      • setExtractionRules

        public void setExtractionRules​(String extractionRules)
        Parameters:
        extractionRules - regex, or "". It is trimmed before saving.
        See Also:
        getExtractionRules()

      • getIdRules

        public String getIdRules()
        A regex representing id rules (matching keys or key paths values are used as TextUnit ids)
        Returns:
        the regex, or "" (not null) if none.

      • setIdRules

        public void setIdRules​(String idRules)
        Parameters:
        idRules - regex, or "". It is trimmed before saving.
        See Also:
        getIdRules()

      • getGenericMetaRules

        public String getGenericMetaRules()
        A regex representing generic metadata rules (matching keys or key paths values)
        Returns:
        the regex, or "" (not null) if none.

      • setGenericMetaRules

        public void setGenericMetaRules​(String genericMetaRules)
        Parameters:
        genericMetaRules - regex, or "". It is trimmed before saving.
        See Also:
        getGenericMetaRules()

      • getUseCodeFinder

        public boolean getUseCodeFinder()

      • setUseCodeFinder

        public void setUseCodeFinder​(boolean useCodeFinder)

      • getSubfilter

        public String getSubfilter()

      • setSubfilter

        public void setSubfilter​(String subfilter)

      • getCodeFinderData

        public String getCodeFinderData()

      • setCodeFinderData

        public void setCodeFinderData​(String data)

      • 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.