Module io.annot8.components.text
Package io.annot8.components.text.processors

Class Clean.Settings

  • All Implemented Interfaces:
    io.annot8.api.settings.Settings
    Enclosing class:
    Clean
    public static class Clean.Settings
extends Object
implements io.annot8.api.settings.Settings

    • Constructor Detail

      • Settings

        public Settings()

    • Method Detail

      • validate

        public boolean validate()
        Specified by:
        validate in interface io.annot8.api.settings.Settings

      • isRemoveSourceContent

        @Description(value="Should the source Content be removed after successful processing?",
             defaultValue="true")
public boolean isRemoveSourceContent()

      • setRemoveSourceContent

        public void setRemoveSourceContent​(boolean removeSourceContent)

      • isTrim

        @Description(value="Should the text be trimmed to remove unnecessary whitespace at the start and end?",
             defaultValue="true")
public boolean isTrim()

      • setTrim

        public void setTrim​(boolean trim)

      • isTrimLines

        @Description(value="Should the lines be trimmed to remove unnecessary whitespace at the start and end of each line?",
             defaultValue="true")
public boolean isTrimLines()

      • setTrimLines

        public void setTrimLines​(boolean trimLines)

      • isRemoveSingleNewLines

        @Description(value="Should single new lines within text be removed?",
             defaultValue="true")
public boolean isRemoveSingleNewLines()

      • setRemoveSingleNewLines

        public void setRemoveSingleNewLines​(boolean removeSingleNewLines)

      • isRemoveRepeatedNewLines

        @Description(value="Should repeated new lines within text be removed? This will reduce repeated new lines to 2 new lines.",
             defaultValue="true")
public boolean isRemoveRepeatedNewLines()

      • setRemoveRepeatedNewLines

        public void setRemoveRepeatedNewLines​(boolean removeRepeatedNewLines)

      • isReplaceSmartCharacters

        @Description(value="Should smart characters (e.g. curly quotes) be replaced with their simpler representations?",
             defaultValue="true")
public boolean isReplaceSmartCharacters()

      • setReplaceSmartCharacters

        public void setReplaceSmartCharacters​(boolean replaceSmartCharacters)

      • isRemoveRepeatedWhitespace

        @Description(value="Should we remove repeated white space characters, and replace with a single space or tab?",
             defaultValue="true")
public boolean isRemoveRepeatedWhitespace()

      • setRemoveRepeatedWhitespace

        public void setRemoveRepeatedWhitespace​(boolean removeRepeatedWhitespace)

      • isCopyProperties

        @Description(value="Should properties be copied from the source Content to the cleaned Content?",
             defaultValue="true")
public boolean isCopyProperties()

      • setCopyProperties

        public void setCopyProperties​(boolean copyProperties)