Package org.opensextant.output

Class OpenSextantSchema

  • public final class OpenSextantSchema
extends java.lang.Object
    GISCore-based output schema.
    Author:
    Marc C. Ubaldino, MITRE, ubaldino at mitre dot org

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static org.opensextant.giscore.events.SimpleField CONFIDENCE
      confidence 0.000 to 1.000 suggests our confidence that we code the MATCH TEXT to the right LAT/LON this is a string for now to keep the actual sig-figs accurate.
      static org.opensextant.giscore.events.SimpleField CONTEXT
      A text window around the MATCH TEXT delineated by START/END offsets.
      static org.opensextant.giscore.events.SimpleField END_OFFSET  
      static org.opensextant.giscore.events.SimpleField FEATURE_CLASS
      Geonames Feature class
      static org.opensextant.giscore.events.SimpleField FEATURE_CODE
      Geonames style feature coding
      static org.opensextant.giscore.events.SimpleField FILENAME  
      static org.opensextant.giscore.events.SimpleField FILEPATH
      Optionally the File path for the text
      static java.lang.String FILEPATH_FLD
      Field names: filepath
      static org.opensextant.giscore.events.SimpleField ISO_COUNTRY
      ISO Country code
      static org.opensextant.giscore.events.SimpleField LAT  
      static org.opensextant.giscore.events.SimpleField LON  
      static org.opensextant.giscore.events.SimpleField MATCH_METHOD
      The method used to match the data in MATCH TEXT
      static org.opensextant.giscore.events.SimpleField MATCH_TEXT
      Match Text captures the raw text matched by the tagger.
      static org.opensextant.giscore.events.SimpleField PLACE_NAME
      the name in the Gazetteer entry; which aligns with the MATCH TEXT
      static org.opensextant.giscore.events.SimpleField PRECISION
      Number of meters of error in coordinate of location.
      static org.opensextant.giscore.events.SimpleField PROVINCE  
      static org.opensextant.giscore.events.SimpleField SCHEMA_OID  
      static org.opensextant.giscore.events.SimpleField START_OFFSET  
      static org.opensextant.giscore.events.SimpleField TEXTPATH  

    • Method Summary

      Modifier and Type Method Description
      static void addDateField​(java.lang.String f)
      Cache an arbitrary date field in schema
      static void addTextField​(java.lang.String f)
      Cache an arbitrary text field in schema
      static org.opensextant.giscore.events.SimpleField getField​(java.lang.String f)  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • SCHEMA_OID

        public static final org.opensextant.giscore.events.SimpleField SCHEMA_OID

      • MATCH_TEXT

        public static final org.opensextant.giscore.events.SimpleField MATCH_TEXT
        Match Text captures the raw text matched by the tagger.

      • ISO_COUNTRY

        public static final org.opensextant.giscore.events.SimpleField ISO_COUNTRY
        ISO Country code

      • FEATURE_CLASS

        public static final org.opensextant.giscore.events.SimpleField FEATURE_CLASS
        Geonames Feature class

      • FEATURE_CODE

        public static final org.opensextant.giscore.events.SimpleField FEATURE_CODE
        Geonames style feature coding

      • CONFIDENCE

        public static final org.opensextant.giscore.events.SimpleField CONFIDENCE
        confidence 0.000 to 1.000 suggests our confidence that we code the MATCH TEXT to the right LAT/LON this is a string for now to keep the actual sig-figs accurate.

      • PRECISION

        public static final org.opensextant.giscore.events.SimpleField PRECISION
        Number of meters of error in coordinate of location. Example, a city location match is likely to be 1-2 KM of error depending on which gazetteer is referenced. A coordinate's precision is implied by number of decimal places, etc.

      • PLACE_NAME

        public static final org.opensextant.giscore.events.SimpleField PLACE_NAME
        the name in the Gazetteer entry; which aligns with the MATCH TEXT

      • FILEPATH_FLD

        public static final java.lang.String FILEPATH_FLD
        Field names: filepath
        See Also:
        Constant Field Values

      • FILEPATH

        public static final org.opensextant.giscore.events.SimpleField FILEPATH
        Optionally the File path for the text

      • FILENAME

        public static final org.opensextant.giscore.events.SimpleField FILENAME

      • TEXTPATH

        public static final org.opensextant.giscore.events.SimpleField TEXTPATH

      • CONTEXT

        public static final org.opensextant.giscore.events.SimpleField CONTEXT
        A text window around the MATCH TEXT delineated by START/END offsets. Default window size is +/- 150 characters

      • START_OFFSET

        public static final org.opensextant.giscore.events.SimpleField START_OFFSET

      • END_OFFSET

        public static final org.opensextant.giscore.events.SimpleField END_OFFSET

      • MATCH_METHOD

        public static final org.opensextant.giscore.events.SimpleField MATCH_METHOD
        The method used to match the data in MATCH TEXT

      • PROVINCE

        public static final org.opensextant.giscore.events.SimpleField PROVINCE

      • LAT

        public static final org.opensextant.giscore.events.SimpleField LAT

      • LON

        public static final org.opensextant.giscore.events.SimpleField LON

    • Constructor Detail

      • OpenSextantSchema

        public OpenSextantSchema()

    • Method Detail

      • addDateField

        public static void addDateField​(java.lang.String f)
        Cache an arbitrary date field in schema

      • addTextField

        public static void addTextField​(java.lang.String f)
        Cache an arbitrary text field in schema