Package org.intermine.task

Class SummariseObjectStoreTask

  • public class SummariseObjectStoreTask
extends org.apache.tools.ant.Task
    Summarise an ObjectStore into a particular properties file. The summary contains:

    counts of the number of objects of each class

    for class fields that have a small number of value, a list of those values.

    Author:
    Kim Rutherford

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.lang.String alias  
      protected java.lang.String configFileName  
      protected java.io.File outputFile  

      • Fields inherited from class org.apache.tools.ant.Task

        description, location, target, taskName, taskType, wrapper

      • Fields inherited from class org.apache.tools.ant.ProjectComponent

        project

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void execute()
      void setAlias​(java.lang.String alias)
      Set the ObjectStore alias
      void setConfigFileName​(java.lang.String configFileName)
      Set the name of the Properties file containing the names of the classes and fields to summarise.
      void setOutputFile​(java.io.File outputFile)
      Set the name of the file to write the summary into

      • Methods inherited from class org.apache.tools.ant.Task

        getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

      • Methods inherited from class org.apache.tools.ant.ProjectComponent

        getProject, setProject

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • alias

        protected java.lang.String alias

      • configFileName

        protected java.lang.String configFileName

      • outputFile

        protected java.io.File outputFile

    • Constructor Detail

      • SummariseObjectStoreTask

        public SummariseObjectStoreTask()

    • Method Detail

      • setAlias

        public void setAlias​(java.lang.String alias)
        Set the ObjectStore alias
        Parameters:
        alias - the ObjectStore alias

      • setConfigFileName

        public void setConfigFileName​(java.lang.String configFileName)
        Set the name of the Properties file containing the names of the classes and fields to summarise.
        Parameters:
        configFileName - the properties file name

      • setOutputFile

        public void setOutputFile​(java.io.File outputFile)
        Set the name of the file to write the summary into
        Parameters:
        outputFile - the output file

      • execute

        public void execute()
        Overrides:
        execute in class org.apache.tools.ant.Task