Package org.anchoranalysis.plugin.io.bean.summarizer.path

Class FilePathPattern

Object
org.anchoranalysis.bean.AnchorBean<Summarizer<T>>
org.anchoranalysis.plugin.io.bean.summarizer.Summarizer<Path>
org.anchoranalysis.plugin.io.bean.summarizer.path.SummarizerPath
org.anchoranalysis.plugin.io.bean.summarizer.path.FilePathPattern
public class FilePathPattern
extends SummarizerPath
Converts a list of file-paths into a form that tries to find a pattern in the naming style using the path-pattern-finder library.

  • Constructor Summary

    Constructors 
    Constructor Description
    FilePathPattern()  
    FilePathPattern​(String... paths)
    Create with one or more paths.

  • Method Summary

    Modifier and Type Method Description
    void add​(Path element)
    Adds a element to the summary.
    String describe()
    A string summarizing this item.
    boolean isIgnoreCase()
    if true, case is ignored in the pattern matching.
    boolean isIgnoreHidden()
    Iff true, any hidden-path is not considered, and simply ignored
    boolean isRemoveExtension()
    if true, the extension is removed from paths before finding the pattern.
    void setIgnoreCase​(boolean ignoreCase)
    if true, case is ignored in the pattern matching.
    void setIgnoreHidden​(boolean ignoreHidden)
    Iff true, any hidden-path is not considered, and simply ignored
    void setRemoveExtension​(boolean removeExtension)
    if true, the extension is removed from paths before finding the pattern.

    Methods inherited from class org.anchoranalysis.plugin.io.bean.summarizer.path.SummarizerPath

    requiresImageMetadata

    Methods inherited from class org.anchoranalysis.plugin.io.bean.summarizer.Summarizer

    addAll

    Methods inherited from class org.anchoranalysis.bean.AnchorBean

    checkMisconfigured, describeBean, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise, toString

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • FilePathPattern

      public FilePathPattern​(String... paths) throws org.anchoranalysis.core.exception.OperationFailedException
      Create with one or more paths.
      Parameters:
      paths - the paths
      Throws:
      org.anchoranalysis.core.exception.OperationFailedException

    • FilePathPattern

      public FilePathPattern()

  • Method Details

    • add

      public void add​(Path element) throws org.anchoranalysis.core.exception.OperationFailedException
      Description copied from class: Summarizer
      Adds a element to the summary.
      Specified by:
      add in class Summarizer<Path>
      Parameters:
      element - the element to add.
      Throws:
      org.anchoranalysis.core.exception.OperationFailedException

    • describe

      public String describe() throws org.anchoranalysis.core.exception.OperationFailedException
      Description copied from class: Summarizer
      A string summarizing this item.
      Specified by:
      describe in class Summarizer<Path>
      Returns:
      the description.
      Throws:
      org.anchoranalysis.core.exception.OperationFailedException

    • isIgnoreHidden

      public boolean isIgnoreHidden()
      Iff true, any hidden-path is not considered, and simply ignored

    • setIgnoreHidden

      public void setIgnoreHidden​(boolean ignoreHidden)
      Iff true, any hidden-path is not considered, and simply ignored

    • isIgnoreCase

      public boolean isIgnoreCase()
      if true, case is ignored in the pattern matching. Otherwise the system-default is used i.e. Windows ingores case, Linux doesn't

    • setIgnoreCase

      public void setIgnoreCase​(boolean ignoreCase)
      if true, case is ignored in the pattern matching. Otherwise the system-default is used i.e. Windows ingores case, Linux doesn't

    • isRemoveExtension

      public boolean isRemoveExtension()
      if true, the extension is removed from paths before finding the pattern.

    • setRemoveExtension

      public void setRemoveExtension​(boolean removeExtension)
      if true, the extension is removed from paths before finding the pattern.