Module io.annot8.components.files
Package io.annot8.components.files.sinks

Class FileSink.Settings

  • All Implemented Interfaces:
    io.annot8.api.settings.Settings
    Enclosing class:
    FileSink
    public static class FileSink.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

      • getRootOutputFolder

        @Description(value="The root folder in which to save files",
             defaultValue=".")
public Path getRootOutputFolder()

      • setRootOutputFolder

        public void setRootOutputFolder​(Path rootOutputFolder)

      • getPropertiesFilename

        @Description(value="The file name for files containing Item and Content properties",
             defaultValue="properties.json")
public String getPropertiesFilename()

      • setPropertiesFilename

        public void setPropertiesFilename​(String propertiesFilename)

      • getContentFilename

        @Description(value="The file name for extracted Content - a suitable extension will be added",
             defaultValue="content")
public String getContentFilename()

      • setContentFilename

        public void setContentFilename​(String contentFilename)

      • getImageType

        @Description(value="The format that image Content should be saved in",
             defaultValue="JPG")
public FileSink.Settings.ImageType getImageType()

      • getAnnotationsFilename

        @Description(value="The file name for files containing Content annotations",
             defaultValue="annotations.json")
public String getAnnotationsFilename()

      • setAnnotationsFilename

        public void setAnnotationsFilename​(String annotationsFilename)

      • getGroupsFilename

        @Description(value="The file name for files containing Item groups",
             defaultValue="groups.json")
public String getGroupsFilename()

      • setGroupsFilename

        public void setGroupsFilename​(String groupsFilename)

      • getBasePaths

        @Description("If the source path of any Item begins with any of these paths, then it will be truncated")
public List<Path> getBasePaths()

      • setBasePaths

        public void setBasePaths​(List<Path> basePaths)

      • isCopyOriginalFile

        @Description(value="If true, and the source file for an item can be identified, then it is copied into the Item folder",
             defaultValue="false")
public boolean isCopyOriginalFile()

      • setCopyOriginalFile

        public void setCopyOriginalFile​(boolean copyOriginalFile)

      • getDescriptionFilename

        @Description(value="The file name for the description of Content",
             defaultValue="description.txt")
public String getDescriptionFilename()

      • setDescriptionFilename

        public void setDescriptionFilename​(String descriptionFilename)

      • isNestFolders

        @Description(value="If true, then Content folders will be nested inside their parent folders where the parent is known",
             defaultValue="false")
public boolean isNestFolders()

      • setNestFolders

        public void setNestFolders​(boolean nestFolders)