Package org.geotools.referencing.wkt

Class AbstractConsole

  • All Implemented Interfaces:
    Runnable
    Direct Known Subclasses:
    Console
    public abstract class AbstractConsole
extends Object
implements Runnable
    Base class for application performing operations on WKT objects from the command line. Instructions are usually read from the standard input stream and results sent to the standard output stream, but those streams can be redirected. The set of allowed instructions depends on the subclass used.
    Since:
    2.1
    Author:
    Martin Desruisseaux (IRD)

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected PrintWriter err
      The error stream, usually the standard one.
      protected LineNumberReader in
      The input stream, usually the standard one.
      protected String lineSeparator
      The line separator, usually the system default.
      protected Writer out
      The output stream, usually the standard one.
      protected Format parser
      The WKT parser, usually a Preprocessor object.

    • Constructor Summary

      Constructors 
      Constructor Description
      AbstractConsole​(Format parser)
      Creates a new console instance using standard input stream, standard output stream, error output stream and the system default line separator.
      AbstractConsole​(Format parser, LineNumberReader in)
      Creates a new console instance using the specified input stream.
      AbstractConsole​(Format parser, LineNumberReader in, Writer out, PrintWriter err, String lineSeparator)
      Creates a new console instance using the specified streams and line separator.

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void addDefinition​(String name, String value)
      Adds a predefined Well Know Text (WKT).
      protected abstract void execute​(String instruction)
      Execute the specified instruction.
      void executeAll()
      Executes all instructions (like run()), but stop at the first error.
      String getPrompt()
      Returns the command-line prompt, or null if there is none.
      void loadDefinitions​(LineNumberReader in)
      Load all definitions from the specified stream.
      Object parseObject​(String text, Class type)
      Parses the specified text.
      void printDefinitions()
      Prints to the output stream a table of all definitions.
      protected void reportError​(Exception exception)
      Print an exception message to the standard error stream.
      void run()
      Process instructions from the input stream specified at construction time.
      void setPrompt​(String prompt)
      Set the command-line prompt, or null for none.
      void stop()
      Stops the run() method.

      • Methods inherited from class Object

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

    • Field Detail

      • in

        protected final LineNumberReader in
        The input stream, usually the standard one.

      • out

        protected final Writer out
        The output stream, usually the standard one.

      • err

        protected final PrintWriter err
        The error stream, usually the standard one.

      • lineSeparator

        protected final String lineSeparator
        The line separator, usually the system default.

      • parser

        protected final Format parser
        The WKT parser, usually a Preprocessor object.

    • Constructor Detail

      • AbstractConsole

        public AbstractConsole​(Format parser)
        Creates a new console instance using standard input stream, standard output stream, error output stream and the system default line separator.
        Parameters:
        parser - The WKT parser, usually a Preprocessor object.

      • AbstractConsole

        public AbstractConsole​(Format parser,
                       LineNumberReader in)
        Creates a new console instance using the specified input stream.
        Parameters:
        parser - The WKT parser, usually a Preprocessor object.
        in - The input stream.

      • AbstractConsole

        public AbstractConsole​(Format parser,
                       LineNumberReader in,
                       Writer out,
                       PrintWriter err,
                       String lineSeparator)
        Creates a new console instance using the specified streams and line separator.
        Parameters:
        parser - The WKT parser, usually a Preprocessor object.
        in - The input stream.
        out - The output stream.
        err - The error stream.
        lineSeparator - The line separator.

    • Method Detail

      • parseObject

        public Object parseObject​(String text,
                          Class type)
                   throws ParseException,
                          FactoryException
        Parses the specified text. The default implementation delegates the work to the parser.
        Parameters:
        text - The text, as a name, a WKT to parse, or an authority code.
        type - The expected type for the object to be parsed (usually a CoordinateReferenceSystem.class or MathTransform.class).
        Returns:
        The object.
        Throws:
        ParseException - if parsing the specified WKT failed.
        FactoryException - if the object is not of the expected type.

      • addDefinition

        public void addDefinition​(String name,
                          String value)
                   throws ParseException
        Adds a predefined Well Know Text (WKT). The value argument given to this method can contains itself other definitions specified in some previous calls to this method. This method do nothing if the parser is not an instance of Preprocessor.
        Parameters:
        name - The name for the definition to be added.
        value - The Well Know Text (WKT) represented by the name.
        Throws:
        IllegalArgumentException - if the name is invalid.
        ParseException - if the WKT can't be parsed.

      • loadDefinitions

        public void loadDefinitions​(LineNumberReader in)
                     throws IOException,
                            ParseException
        Load all definitions from the specified stream. Definitions are key-value pairs in the form name = wkt (without the SET keyword). The result is the same than invoking the SET instruction for each line in the specified stream. This method is used for loading predefined objects like the database used by PropertyAuthorityFactory.
        Parameters:
        in - The input stream.
        Throws:
        IOException - if an input operation failed.
        ParseException - if a well know text (WKT) can't be parsed.

      • printDefinitions

        public void printDefinitions()
                      throws IOException
        Prints to the output stream a table of all definitions. The content of this table is inferred from the values given to the addDefinition(java.lang.String, java.lang.String) method. This method print nothing if the parser is not an instance of Preprocessor.
        Throws:
        IOException - if an error occured while writting to the output stream.

      • getPrompt

        public String getPrompt()
        Returns the command-line prompt, or null if there is none.

      • setPrompt

        public void setPrompt​(String prompt)
        Set the command-line prompt, or null for none.

      • run

        public void run()
        Process instructions from the input stream specified at construction time. All lines are read until the end of stream ([Ctrl-Z] for input from the keyboard), or until stop() is invoked. Non-empty and non-comment lines are given to the execute(java.lang.String) method. Errors are catched and printed to the error stream.
        Specified by:
        run in interface Runnable

      • executeAll

        public void executeAll()
                throws Exception
        Executes all instructions (like run()), but stop at the first error.
        Throws:
        Exception - if an instruction failed.

      • execute

        protected abstract void execute​(String instruction)
                         throws Exception
        Execute the specified instruction.
        Parameters:
        instruction - The instruction to execute.
        Throws:
        Exception - if the instruction failed.

      • stop

        public void stop()
        Stops the run() method. This method can been invoked from any thread. If a line is in process, it will be finished before the run() method stops.

      • reportError

        protected void reportError​(Exception exception)
        Print an exception message to the standard error stream. The error message includes the line number, and the column where the failure occured in the exception is an instance of ParseException.
        Parameters:
        exception - The exception to report.