-
Notifications
You must be signed in to change notification settings - Fork 74
v0.2.47..v0.2.48 changeset info.asciidoc
Garret Voltz edited this page Sep 27, 2019
·
1 revision
diff --git a/docs/commands/info.asciidoc b/docs/commands/info.asciidoc
index 8c2165a..4fa073b 100644
--- a/docs/commands/info.asciidoc
+++ b/docs/commands/info.asciidoc
@@ -1,7 +1,7 @@
[[info]]
== info
-The +info+ command displays information about Hootenanny capabilities.
+The +info+ command displays information about Hootenanny capabilities.
For further detail on how to use this information see both the Hootenanny User and Developer Guides.
@@ -11,6 +11,7 @@ Only one of the following options can be passed to the command:
* +--cleaning-operations+ - Displays operations configured for cleaning map data
* +--config-options+ - Displays available configuration options
+* +--conflatable-criteria+ - Displays criteria that identify conflatable elements
* +--conflate-post-operations+ - Displays operations configured by default to run after a conflation job (can be customized via the
`conflate.post.ops` configuration option)
* +--conflate-pre-operations+ - Displays operations configured by default to run before a conflation job (can be customized via the
@@ -28,6 +29,7 @@ Only one of the following options can be passed to the command:
* +--subline-string-matchers+ - Displays available subline string matchers
* +--tag-mergers+ - Displays available feature tag mergers used during conflation
* +--value-aggregators+ - Displays available feature tag value aggregators used in conflation model building
+* +--way-joiners+ - Displays available way joiners
Each of the following sections describes an option that may be used with this command and its input parameters.
@@ -57,9 +59,9 @@ The +--config-options+ option prints out available Hootenanny configuration opti
One of the following input parameters must be specified:
* +name+ - name or partial name of a configuration option to list and/or print a description for
-* +--option-names+ - if no name is specified, lists all configuration option names; if a name is specified, lists only
+* +--option-names+ - if no name is specified, lists all configuration option names; if a name is specified, lists only
configuration option names that have a full or partial match with the input name
-* +--option-details+ - if no name is specified, lists all configuration option names and descriptions; if a name is specified,
+* +--option-details+ - if no name is specified, lists all configuration option names and descriptions; if a name is specified,
lists only configuration option names and descriptions that have a full or partial match with the input name
==== Usage
@@ -90,6 +92,22 @@ hoot info --config-options poi.polygon --option-names
hoot info --config-options poi.polygon --option-details
--------------------------------------
+=== Conflatable Criteria
+
+The +--conflatable-crieria++ option prints out all element criteria classes that can be used to identify conflatable elements.
+
+==== Usage
+
+--------------------------------------
+info --conflatable-crieria
+--------------------------------------
+
+==== Example
+
+--------------------------------------
+hoot info --conflatable-crieria
+--------------------------------------
+
=== Conflate Post Operations
The +--conflate-post-operations+ option prints out the currently configured operations to run immediately after a conflation job with the
@@ -126,8 +144,8 @@ hoot info --conflate-pre-operations
=== Feature Extractors
-The +--feature-extractors+ option prints out available feature extractors that can be used when building a conflation model with
-manually matched map training data.
+The +--feature-extractors+ option prints out available feature extractors that can be used when building a conflation model with
+manually matched map training data.
==== Usage
@@ -143,12 +161,13 @@ hoot info --feature-extractors
=== Formats
-The +--formats+ option prints out supported data formats.
+The +--formats+ option prints out supported data formats. The --input-bounded sub-option prints out input formats that support bounded reads
+with the `convert.bounding.box` configuration option.
==== Usage
--------------------------------------
-info --formats [--input] [--output]
+info --formats [--input] [--output] [--input-bounded]
--------------------------------------
==== Example
@@ -157,21 +176,23 @@ info --formats [--input] [--output]
# prints all
hoot info --formats
-hoot info --format --input
+hoot info --formats --input
+
+hoot info --formats --output
-hoot info --format --output
+hoot info --formats --input-bounded
--------------------------------------
=== Languages
The +languages+ option displays information about Hootenanny language translation/detection capabilities.
-All uses of the +languages+ command require the following configuration options to be populated:
+All uses of the +languages+ command require the following configuration options to be populated:
* hoot.services.auth.user.name
* hoot.services.auth.access.token
* hoot.services.auth.access.token.secret
-For more information on logging into the web services, see the 'login' command documentation. Those options are omitted from the
+For more information on logging into the web services, see the 'login' command documentation. Those options are omitted from the
following command examples.
Only one of the following options can be passed to the command:
@@ -223,7 +244,7 @@ info --languages --detectable
hoot info --languages --detectable
--------------------------------------
-The +--translatable+ option prints out spoken languages which Hootenanny can translate from to English when using the Hootenanny web
+The +--translatable+ option prints out spoken languages which Hootenanny can translate from to English when using the Hootenanny web
services.
==== Usage
@@ -309,10 +330,10 @@ hoot info --merger-creators
=== Operators
The +--operators+ option prints out available inline operators that can be applied to map data in a Hootenanny command. Map operators
-can be criterion, operations, or visitors.
+can be criterion, operations, or visitors.
-* An example of an operation is DuplicateWayRemover, which removes all duplicate ways from a map.
-* An example of a criterion is NodeCriterion, which acts as a filter to return all nodes in a map.
+* An example of an operation is DuplicateWayRemover, which removes all duplicate ways from a map.
+* An example of a criterion is NodeCriterion, which acts as a filter to return all nodes in a map.
* An example of a visitor is RemoveTagsVisitor, which removes selected tags from features in a map.
==== Usage
@@ -328,7 +349,7 @@ info --operators
hoot info --operators
# criterion example - filters only nodes from the map to the output
-hoot convert -D convert.ops="hoot::RemoveElementsVisitor" -D remove.elements.visitor.element.criteria="hoot::NodeCriterion" \
+hoot convert -D convert.ops="hoot::RemoveElementsVisitor" -D remove.elements.visitor.element.criteria="hoot::NodeCriterion" \
input1.osm input2.osm output.osm
# operation example - writes a map based on the input data with all duplicate ways removed
@@ -340,7 +361,7 @@ hoot convert -D convert.ops="hoot::RemoveTagsVisitor" -D remove.tags.visitor.ele
=== Subline Matchers
-The +--subline-matchers+ option prints out available subline matchers that determine which method of line matching is used during conflation.
+The +--subline-matchers+ option prints out available subline matchers that determine which method of line matching is used during conflation.
==== Usage
@@ -356,8 +377,8 @@ hoot info --subline-matchers
=== Subline String Matchers
-The +--subline-string-matchers+ option prints out available subline string matchers that determine which method of multilinestring matching
-is used during conflation.
+The +--subline-string-matchers+ option prints out available subline string matchers that determine which method of multilinestring matching
+is used during conflation.
==== Usage
@@ -373,7 +394,7 @@ hoot info --subline-string-matchers
=== String Comparators
-The +--string-comparators+ option prints out available string comparators that can be used during conflation when comparing tag string values.
+The +--string-comparators+ option prints out available string comparators that can be used during conflation when comparing tag string values.
==== Usage
@@ -411,8 +432,8 @@ hoot info --tag-mergers
=== Value Aggregators
-The +--value-aggregators+ option prints out available tag value aggregation methods that can be used when building a conflation model with
-manually matched map training data.
+The +--value-aggregators+ option prints out available tag value aggregation methods that can be used when building a conflation model with
+manually matched map training data.
==== Usage
@@ -426,3 +447,20 @@ info --value-aggregators
hoot info --value-aggregators
--------------------------------------
+=== Way Joiners
+
+The +--way-joiners+ option prints out all way joiner class implementations that may either be used independently or in conjunction with
+the OsmMapOperation, `hoot::WayJoinerOp`.
+
+==== Usage
+
+--------------------------------------
+info --way-joiners
+--------------------------------------
+
+==== Example
+
+--------------------------------------
+hoot info --way-joiners
+--------------------------------------
+