Equity Analysis Tool

The software will look for a default folder named eatool in your root folder.
For Windows this would be c:\eatool

If this folder is found the eatool.properties file saved in the etc folder 
will be used on startup.
If this folder and/or file is not found a default properties file included 
in the application will be used.

If you use the software regularly it is recommended to use the default folder 
location and save your preferences 
in the etc folder in a file name eatool.properties.


* Default Directory Structure

  +eatool       - top level folder - application is run from here
    +data
      +input    - files to be converted should be placed here
      +output   - output of data conversion is placed here by default
      +temp     - default location of temporary files
    +etc        - configuration files for running data conversion

You may specify different directories in your own configuration file.

* Files

  eat.jar - application file
  looks-2.0.2.jar – application file
  run.cmd - command line utility to run application on windows java runtime
            is not configured in the environment

  eatool.properties            - configuration file for conversion
  sql.properties               - sample configuration file to generate sql
                                 script for adding data to a database
  selected-symbols-2006.txt    - sample symbol file to restrict conversion

* Running the application

  1) Make sure you have a java runtime installed on your computer
     You may download one at http://java.sun.com/javase/downloads/index.jsp
  1) edit eatool.properties and ensure all file paths are correct
  2) GUI version - you may double click on the eat.jar file in windows to
     start the program if the java runtime is configured on your computer
     You may edit and use the run.cmd file for windows if you have problems
  3) Command Line: java -jar eat.jar -nogui c:\eatool\etc\eat.properties


* How to Convert Data with the GUI

  1) select files to convert in the file selection tab
  2) verify selected symbols on the symbol selection tab
     note: empty selected symbols list will convert all symbols 
  3) verify and change conversion options on the options tab
  4) click convert on the conversion tab


* Features

  - you may filter the symbols in the conversion by adding them to the
    symbols.txt file
  - the eatool.properties allows you to set the following features

        # where to read briter systems files from
        inputFilePath = c:/eatool/data/input
        # where to place converted files
        outputFilePath = c:/eatool/data/output
        # folder to place temporary files
        temporaryFilePath = c:/eatool/data/temp

        ############################################################
        #       Conversion properties
        ############################################################

        # add converted data to existing files
        appendToFiles = false

        # make first line in output the column names
        columnHeaderLine = false

        # format used to convert date - see below for more options
        dateFormat = yyyy/MM/dd

        # file name to use for a single output file
        singleFileName = convertedData.csv

        # file listing symbols to limit conversion to
        selectedSymbols = c:/eatool/etc/symbol.txt

        # decimal precision for numeric values (0-4)
        decimalPrecision = 2

        # place single quotes ' around text fields
        singleQuoteStrings = true

        # place double quotes " around text fields
        doubleQuoteStrings = false

        # place the following text at the beginning of each line
        # see the sql.properties for use
        startWithText =

        # place the following text at the end of each line
        # see the sql.properties for use
        endWithText =

        # create a seperate file for each symbol in conversion
        # the file name will be the symbol plus the extension defined below
        oneFilePerSymbol = false

        # filename extension to append to the end of symbol names in the
         multipleFileExtension = .csv

        ############################################################
        #       Selected Field List
        ############################################################
        # number indicates position of the column in the output file
        # use a zero to exclude the column
        NAME = 2
        SYMBOL = 1
        QUOTE_DATE = 3
        CURRENT_PRICE = 4
        CHANGE_VALUE = 5
        CHANGE_PERCENT = 6
        PREVIOUS_CLOSE = 7
        OPEN = 8
        VOLUME = 9
        DAY_MIN_PRICE = 10
        DAY_MAX_PRICE = 11
        PRICE_TO_EARNINGS = 0
        MARKET_CAP = 0
        AVERAGE_VOLUME = 0
        YEAR_MIN_PRICE = 0
        YEAR_MAX_PRICE = 0
        DIVIDEND_VALUE = 0
        EARNINGS_PER_SHARE = 0
        DIVIDEND_YIELD = 0
        CURRENT_PRICE_RANK = 0
        CHANGE_VALUE_RANK = 0
        CHANGE_PERCENT_RANK = 0
        VOLUME_RANK = 0
        PRICE_TO_EARNINGS_RANK = 0
        MARKET_CAP_RANK = 0
        AVERAGE_VOLUME_RANK = 0
        YEAR_MIN_PRICE_RANK = 0
        YEAR_MAX_PRICE_RANK = 0
        DIVIDEND_VALUE_RANK = 0
        EARNINGS_PER_SHARE_RANK = 0
        DIVIDEND_YIELD_RANK = 0
        CURRENT_PRICE_VALUE = 0
        CHANGE_VALUE_VALUE = 0
        CHANGE_PERCENT_VALUE = 0
        VOLUME_VALUE = 0
        PRICE_TO_EARNINGS_VALUE = 0
        MARKET_CAP_VALUE = 0
        AVERAGE_VOLUME_VALUE = 0
        YEAR_MIN_PRICE_VALUE = 0
        YEAR_MAX_PRICE_VALUE = 0
        DIVIDEND_VALUE_VALUE = 0
        EARNINGS_PER_SHARE_VALUE = 0
        DIVIDEND_YIELD_VALUE = 0

  * Date format Options

        Letter  Date or Time Component
        G       Era designator
        y       Year
        M       Month in year
        w       Week in year
        W       Week in month
        D       Day in year
        d       Day in month
        F       Day of week in month
        E       Day in week
        a       Am/pm marker
        H       Hour in day (0-23)
        k       Hour in day (1-24)
        K       Hour in am/pm (0-11)
        h       Hour in am/pm (1-12)
        m       Minute in hour
        s       Second in minute
        S       Millisecond
        z       Time zone
        Z       Time zone

       Examples
        The following examples show how date and time patterns are interpreted
        in the U.S. locale. The given date and time are 2001-07-04 12:08:56
        local time in the U.S. Pacific Time time zone.

            Date and Time Pattern               Result
            "yyyy.MM.dd G 'at' HH:mm:ss z"      2001.07.04 AD at 12:08:56 PDT
            "EEE, MMM d, ''yy"                  Wed, Jul 4, '01
            "h:mm a"                            12:08 PM
            "hh 'o''clock' a, zzzz"             12 o'clock PM, Pacific Daylight Time
            "K:mm a, z"                         0:08 PM, PDT
            "yyyyy.MMMMM.dd GGG hh:mm aaa"      02001.July.04 AD 12:08 PM
            "EEE, d MMM yyyy HH:mm:ss Z"        Wed, 4 Jul 2001 12:08:56 -0700
            "yyMMddHHmmssZ"                     010704120856-0700