Class Parameters

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Object,​java.lang.Object>

    public class Parameters
    extends java.util.Properties
    Author:
    Marc C. Ubaldino, MITRE, ubaldino at mitre dot org
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      boolean clean_input  
      static int FLAG_EXTRACT_CONTEXT  
      static int FLAG_NO_COORDINATES  
      java.lang.String inputFile  
      static java.lang.String INVALID_FCNAME_CHAR  
      boolean isdefault
      You the caller must explicitly set isdefault = false; forcing you to actually look at these parameters.
      boolean output_coordinate_duplicates
      Is the concept of duplicate filtering more general than for just coords?
      boolean output_filtered
      By default Country Names will not be included in GIS products They should appear in CSV, though.
      boolean output_geohash
      Default is to not generate Geohash
      java.lang.String outputDir  
      java.lang.String outputFile  
      java.util.HashMap<java.lang.String,​java.util.List<java.lang.String>> preferredGeography
      A way of relaying arbitrary geographic filters to an extraction routine indicating that useful answers for disambiguation for tie-breakers come from these cues.
      boolean resolve_localities
      Reverse Geo here is accommodated by resolving Provinces and Localities when a geodetic coordinate is encountered in text.
      static int RUNTIME_FLAGS  
      boolean tag_codes
      Tag/Output codes of placenames -- Exclusive of Coutry or other Placenames
      boolean tag_coordinates
      Tag/Output coordinates
      boolean tag_countries
      Tag/Output countries
      boolean tag_lowercase  
      boolean tag_names
      Generic flag to represent tagging non-Geo names, e.g., names of persons, orgs and things
      boolean tag_patterns  
      boolean tag_places
      Tag/Output placenames of any time other than countries
      boolean tag_postal
      Tag/Output postal hierarchy, i.e., "City, Province, Postal code"
      boolean tag_taxons  
      java.lang.String tempDir  
      • Fields inherited from class java.util.Properties

        defaults
    • Constructor Summary

      Constructors 
      Constructor Description
      Parameters()  
    • Method Summary

      Modifier and Type Method Description
      void addOutputFormat​(java.lang.String fmt)
      Processing will support multiple output formats
      java.lang.String getJobName()  
      static java.lang.String getJobTimestamp()
      Generates a simple job date/time key for the job
      java.util.Set<java.lang.String> getOutputFormats()  
      void setJobName​(java.lang.String nm)  
      • Methods inherited from class java.util.Properties

        clear, clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, get, getOrDefault, getProperty, getProperty, hashCode, isEmpty, keys, keySet, list, list, load, load, loadFromXML, merge, propertyNames, put, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, save, setProperty, size, store, store, storeToXML, storeToXML, storeToXML, stringPropertyNames, toString, values
      • Methods inherited from class java.lang.Object

        finalize, getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • tag_countries

        public boolean tag_countries
        Tag/Output countries
      • tag_places

        public boolean tag_places
        Tag/Output placenames of any time other than countries
      • tag_coordinates

        public boolean tag_coordinates
        Tag/Output coordinates
      • tag_codes

        public boolean tag_codes
        Tag/Output codes of placenames -- Exclusive of Coutry or other Placenames
      • tag_postal

        public boolean tag_postal
        Tag/Output postal hierarchy, i.e., "City, Province, Postal code"
      • tag_names

        public boolean tag_names
        Generic flag to represent tagging non-Geo names, e.g., names of persons, orgs and things
      • tag_taxons

        public boolean tag_taxons
      • tag_patterns

        public boolean tag_patterns
      • tag_lowercase

        public boolean tag_lowercase
      • clean_input

        public boolean clean_input
      • resolve_localities

        public boolean resolve_localities
        Reverse Geo here is accommodated by resolving Provinces and Localities when a geodetic coordinate is encountered in text. The containing province and/or closest feature is reported. Country code and ADM1 code, and Province Name are inferred and set on coordinate object, improving the contextual information for the rest of the processing.
      • output_filtered

        public boolean output_filtered
        By default Country Names will not be included in GIS products They should appear in CSV, though.
      • output_geohash

        public boolean output_geohash
        Default is to not generate Geohash
      • output_coordinate_duplicates

        public boolean output_coordinate_duplicates
        Is the concept of duplicate filtering more general than for just coords?
      • tempDir

        public java.lang.String tempDir
      • outputDir

        public java.lang.String outputDir
      • inputFile

        public java.lang.String inputFile
      • outputFile

        public java.lang.String outputFile
      • preferredGeography

        public java.util.HashMap<java.lang.String,​java.util.List<java.lang.String>> preferredGeography
        A way of relaying arbitrary geographic filters to an extraction routine indicating that useful answers for disambiguation for tie-breakers come from these cues. "countries" = [c1, c2, c3, ...] "geohash" = [g1, g2, g3, ...]
      • isdefault

        public boolean isdefault
        You the caller must explicitly set isdefault = false; forcing you to actually look at these parameters.
      • RUNTIME_FLAGS

        public static int RUNTIME_FLAGS
      • INVALID_FCNAME_CHAR

        public static final java.lang.String INVALID_FCNAME_CHAR
        See Also:
        Constant Field Values
    • Constructor Detail

      • Parameters

        public Parameters()
    • Method Detail

      • addOutputFormat

        public void addOutputFormat​(java.lang.String fmt)
        Processing will support multiple output formats
        Parameters:
        fmt - requested format
      • getOutputFormats

        public java.util.Set<java.lang.String> getOutputFormats()
      • setJobName

        public void setJobName​(java.lang.String nm)
      • getJobName

        public java.lang.String getJobName()
      • getJobTimestamp

        public static java.lang.String getJobTimestamp()
        Generates a simple job date/time key for the job
        Returns:
        12-digit processing date format date+time