Package org.mycore.iview2.frontend

Class MCRIView2Commands

java.lang.Object
org.mycore.frontend.cli.MCRAbstractCommands
org.mycore.iview2.frontend.MCRIView2Commands
All Implemented Interfaces:
MCRExternalCommandInterface
@MCRCommandGroup(name="IView2 Tile Commands") public class MCRIView2Commands extends MCRAbstractCommands
Provides commands for Image Viewer.
Author:
Thomas Scheffler (yagee)

  • Constructor Details

    • MCRIView2Commands

      public MCRIView2Commands()

  • Method Details

    • tileAll

      @MCRCommand(syntax="tile images of all derivates", help="tiles all images of all derivates with a supported image type as main document", order=40) public static List<String> tileAll()
      meta command to tile all images of all derivates.
      Returns:
      list of commands to execute.

    • checkAll

      @MCRCommand(syntax="check tiles of all derivates", help="checks if all images have valid iview2 files and start tiling if not", order=10) public static List<String> checkAll()
      meta command to check (and repair) tiles of all images of all derivates.
      Returns:
      list of commands to execute.

    • tileAllOfProject

      @MCRCommand(syntax="tile images of derivates of project {0}", help="tiles all images of derivates of a project with a supported image type as main document", order=41) public static List<String> tileAllOfProject(String project)
      meta command to tile all images of derivates of a project.
      Returns:
      list of commands to execute.

    • checkAllOfProject

      @MCRCommand(syntax="check tiles of derivates of project {0}", help="checks if all images have valid iview2 files and start tiling if not", order=11) public static List<String> checkAllOfProject(String project)
      meta command to check (and repair) tiles of all images of derivates of a project.
      Returns:
      list of commands to execute.

    • tileDerivatesOfObject

      @MCRCommand(syntax="tile images of object {0}", help="tiles all images of derivates of object {0} with a supported image type as main document", order=50) public static List<String> tileDerivatesOfObject(String objectID)
      meta command to tile all images of derivates of an object .
      Parameters:
      objectID - a object ID
      Returns:
      list of commands to execute.

    • tileDerivate

      @MCRCommand(syntax="tile images of derivate {0}", help="tiles all images of derivate {0} with a supported image type as main document", order=60) public static List<String> tileDerivate(String derivateID) throws IOException
      meta command to tile all images of this derivate.
      Parameters:
      derivateID - a derivate ID
      Returns:
      list of commands to execute.
      Throws:
      IOException

    • checkTilesOfDerivate

      @MCRCommand(syntax="check tiles of derivate {0}", help="checks if all images of derivate {0} with a supported image type as main document have valid iview2 files and start tiling if not ", order=20) public static List<String> checkTilesOfDerivate(String derivateID) throws IOException
      meta command to check (and repair) all tiles of all images of this derivate.
      Parameters:
      derivateID - a derivate ID
      Returns:
      list of commands to execute.
      Throws:
      IOException

    • fixDeadEntries

      @MCRCommand(syntax="fix dead tile jobs", help="Deletes entries for files which dont exist anymore!") public static void fixDeadEntries()

    • checkImage

      @MCRCommand(syntax="check tiles of image {0} {1}", help="checks if tiles a specific file identified by its derivate {0} and absolute path {1} are valid or generates new one", order=30) public static void checkImage(String derivate, String absoluteImagePath) throws IOException
      checks and repairs tile of this derivate.
      Parameters:
      derivate - derivate ID
      absoluteImagePath - absolute path to image file
      Throws:
      IOException

    • tileImage

      @MCRCommand(syntax="tile image {0} {1}", help="tiles a specific file identified by its derivate {0} and absolute path {1}", order=70) public static void tileImage(String derivate, String absoluteImagePath)
      Tiles this image.
      Parameters:
      derivate - derivate ID
      absoluteImagePath - absolute path to image file

    • tileImage

      public static void tileImage(MCRPath file) throws IOException
      Tiles this MCRPath
      Throws:
      IOException

    • deleteAllTiles

      @MCRCommand(syntax="delete all tiles", help="removes all tiles of all derivates", order=80) public static void deleteAllTiles() throws IOException
      Deletes all image tiles.
      Throws:
      IOException

    • deleteDerivateTilesOfObject

      @MCRCommand(syntax="delete tiles of object {0}", help="removes tiles of a specific file identified by its object ID {0}", order=90) public static List<String> deleteDerivateTilesOfObject(String objectID)
      Deletes all image tiles of derivates of this object.
      Parameters:
      objectID - a object ID

    • deleteDerivateTiles

      @MCRCommand(syntax="delete tiles of derivate {0}", help="removes tiles of a specific file identified by its derivate ID {0}", order=100) public static void deleteDerivateTiles(String derivateID) throws IOException
      Deletes all image tiles of this derivate.
      Parameters:
      derivateID - a derivate ID
      Throws:
      IOException

    • deleteImageTiles

      @MCRCommand(syntax="delete tiles of image {0} {1}", help="removes tiles of a specific file identified by its derivate ID {0} and absolute path {1}", order=110) public static void deleteImageTiles(String derivate, String absoluteImagePath) throws IOException
      Deletes all image tiles of this derivate.
      Parameters:
      derivate - derivate ID
      absoluteImagePath - absolute path to image file
      Throws:
      IOException