Class Parameters

All Implemented Interfaces:
Serializable, Cloneable, Map<Object,Object>

public class Parameters extends Properties
Author:
Marc C. Ubaldino, MITRE, ubaldino at mitre dot org
See Also:
  • Field Details

    • 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_taxons

      public boolean tag_taxons
      "taxons" is a catch all for the non-geo items that come out of geotagger, e.g., negated tags such as the surname "Johnson" -- typically a surname and not a city. These tags are a by-product of Geotagging and available to caller.
    • tag_all_taxons

      public boolean tag_all_taxons
      "all taxons" is an explicit request to tag all keyphrases AKA taxons
    • tag_names

      public boolean tag_names
      Name taxons are a special grouping of tags, including "person_name" and other entries Entity type is usually `person`. This group is differentiated from non-name tags such as assets or codes.
    • 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 String tempDir
    • outputDir

      public String outputDir
    • inputFile

      public String inputFile
    • outputFile

      public String outputFile
    • preferredGeography

      public HashMap<String,List<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.
    • FLAG_EXTRACT_CONTEXT

      public static final int FLAG_EXTRACT_CONTEXT
      See Also:
    • FLAG_NO_COORDINATES

      public static final int FLAG_NO_COORDINATES
      See Also:
    • RUNTIME_FLAGS

      public static int RUNTIME_FLAGS
    • INVALID_FCNAME_CHAR

      public static final String INVALID_FCNAME_CHAR
      See Also:
  • Constructor Details

    • Parameters

      public Parameters()
  • Method Details

    • addOutputFormat

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

      public Set<String> getOutputFormats()
    • setJobName

      public void setJobName(String nm)
    • getJobName

      public String getJobName()
    • getJobTimestamp

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