org.geotools.factory
Class Hints

Object
  extended by RenderingHints
      extended by Hints
All Implemented Interfaces:
Cloneable, Map<Object,Object>

public class Hints
extends RenderingHints

A set of hints providing control on factories to be used. Those hints are typically used by renderers or grid coverage processors for example. They provides a way to control low-level details. Example:

 CoordinateOperationFactory myFactory = &hellip
 Hints hints = new Hints(Hints.COORDINATE_OPERATION_FACTORY, myFactory);
 AbstractProcessor processor = new DefaultProcessor(hints);
 

Any hint mentioned by this class is considered to be API, failure to make use of a hint by a GeoTools factory implementation is considered a bug (as it will prevent the use of this library for application specific tasks).

When hints are used in conjunction with the factory service discovery mechanism we have the complete geotools plugin system. By using hints to allow application code to effect service discovery we allow client code to retarget the geotools library for their needs.

Since:
2.1
Author:
Martin Desruisseaux, Jody Garnett
Module:
modules/library/metadata (gt-metadata.jar)

Nested Class Summary
static class Hints.ClassKey
          A key for value that may be specified either as instance of T, or as Class<T>.
static class Hints.DoubleKey
          A hint used to capture a configuration setting as double.
static class Hints.FileKey
          Key for hints to be specified as a File.
static class Hints.IntegerKey
          A hint used to capture a configuration setting as an integer.
static class Hints.Key
          The type for keys used to control various aspects of the factory creation.
static class Hints.OptionKey
          Key that allows the choice of several options.
 
Nested classes/interfaces inherited from interface Map
Map.Entry<K,V>
 
Field Summary
static Hints.Key AGGREGATE_FACTORY
          The AggregateFactory instance to use.
static Hints.Key ASSOCIATION_PROPERTY
          The name of a property to traverse in a datastore query.
static Hints.Key ASSOCIATION_TRAVERSAL_DEPTH
          The maximum number of associations traversed in a datastore query.
static Hints.ClassKey ATTRIBUTE_TYPE_FACTORY
          The AttributeTypeFactory instance to use.
static Hints.IntegerKey AUTHORITY_MAX_ACTIVE
          The maximum number of active authority factories.
static Hints.IntegerKey AUTHORITY_MAX_IDLE
          The number of idle AuthorityFactories.
static Hints.IntegerKey AUTHORITY_MIN_EVICT_IDLETIME
          When the evictor is run, if more time (in milliseconds) than the value in AUTHORITY_MIN_EVICT_IDLETIME has passed, then the worker is destroyed.
static Hints.IntegerKey AUTHORITY_MIN_IDLE
          Minimum number of objects required before the evictor will begin removing objects.
static Hints.IntegerKey AUTHORITY_SOFTMIN_EVICT_IDLETIME
          When the evictor is run, workers which have been idle for more than this value will be destroyed if and only if the number of idle workers exceeds AUTHORITY_MIN_IDLE.
static Hints.IntegerKey AUTHORITY_TIME_BETWEEN_EVICTION_RUNS
          Time in milliseconds to wait between eviction runs.
static Hints.IntegerKey CACHE_LIMIT
          The recommended maximum number of referencing objects to hold in a authority factory.
static Hints.OptionKey CACHE_POLICY
          Policy to use for caching referencing objects.
static Hints.DoubleKey COMPARISON_TOLERANCE
          Tolerance used in comparisons between floating point values.
static Hints.Key COMPLEX_FACTORY
          The ComplexFactory instance to use.
static Hints.Key COORDINATE_DIMENSION
          The actual coordinate dimensions of the geometry (to be used in the GeometryDescriptor user map)
static Hints.ClassKey COORDINATE_OPERATION_AUTHORITY_FACTORY
          The CoordinateOperationAuthorityFactory instance to use.
static Hints.ClassKey COORDINATE_OPERATION_FACTORY
          The CoordinateOperationFactory instance to use.
static Hints.Key COVERAGE_PROCESSING_VIEW
          Forces the grid coverage processor to perform operations on the specified view.
static Hints.Key CRS
          The CoordinateReferenceSystem to use in ISO geometry factories.
static Hints.FileKey CRS_AUTHORITY_EXTRA_DIRECTORY
          Used to direct WKT CRS Authority to a directory containing extra definitions.
static Hints.ClassKey CRS_AUTHORITY_FACTORY
          The CRSAuthorityFactory instance to use.
static Hints.ClassKey CRS_FACTORY
          The CRSFactory instance to use.
static Hints.ClassKey CS_AUTHORITY_FACTORY
          The CSAuthorityFactory instance to use.
static Hints.ClassKey CS_FACTORY
          The CSFactory instance to use.
static Hints.ClassKey DATUM_AUTHORITY_FACTORY
          The DatumAuthorityFactory instance to use.
static Hints.ClassKey DATUM_FACTORY
          The DatumFactory instance to use.
static Hints.OptionKey DATUM_SHIFT_METHOD
          The preferred datum shift method to use for coordinate operations.
static Hints.Key DEFAULT_COORDINATE_REFERENCE_SYSTEM
          The default CoordinateReferenceSystem to use.
static Hints.Key EPSG_DATA_SOURCE
          The data source name to lookup from JNDI when initializing the EPSG factory.
static Hints.Key FEATURE_2D
          Request that the features returned by the feature collections should be 2D only.
static Hints.ClassKey FEATURE_COLLECTIONS
          The FeatureCollections instance to use.
static Hints.Key FEATURE_DETACHED
          Whether the features returned by the feature collections should be considered detached from the datastore, that is, they are updatable without altering the backing store (makes sense only if features are kept in memory or if there is some transparent persistent mechanism in place, such as the Hibernate one)
static Hints.ClassKey FEATURE_FACTORY
          The FeatureFactory instance to use.
static Hints.ClassKey FEATURE_LOCK_FACTORY
          The FeatureLockFactory instance to use.
static Hints.ClassKey FEATURE_TYPE_FACTORY
          The FeatureTypeFactory instance to use.
static Hints.Key FEATURE_TYPE_FACTORY_NAME
          Deprecated. This hint controls FeatureTypeBuilder which is now deprecated
static Hints.ClassKey FILTER_FACTORY
          The FilterFactory instance to use.
static Hints.Key FORCE_AXIS_ORDER_HONORING
          Applies the FORCE_LONGITUDE_FIRST_AXIS_ORDER hint to some factories that usually ignore it.
static Hints.Key FORCE_LONGITUDE_FIRST_AXIS_ORDER
          Tells if the coordinate systems created by an authority factory should be forced to (longitude,latitude) axis order.
static Hints.Key FORCE_STANDARD_AXIS_DIRECTIONS
          Tells if the coordinate systems created by an authority factory should be forced to standard axis directions.
static Hints.Key FORCE_STANDARD_AXIS_UNITS
          Tells if the coordinate systems created by an authority factory should be forced to standard axis units.
static Hints.Key GEOMETRY_DISTANCE
          Asks a datastore having a vector pyramid (pre-generalized geometries) to return the geometry version whose points have been generalized less than the spefiedi distance (further generalization might be performed by the client in memory).
static Hints.Key GEOMETRY_FACTORY
          The GeometryFactory instance to use.
static Hints.Key GEOMETRY_GENERALIZATION
          Asks a datastore to perform a topology preserving on the fly generalization of the geometries.
static Hints.Key GEOMETRY_SIMPLIFICATION
          Asks a datastore to perform a non topology preserving on the fly generalization of the geometries (e.g., returning self crossing polygons as a result of the geoneralization is considered valid).
static Hints.Key GEOMETRY_VALIDATE
          If true, geometry will be validated on creation.
static Hints.Key GRID_COVERAGE_PROCESSOR
          Deprecated. The GridCoverageProcessor interface is not yet stable. Avoid dependencies if possible.
static Hints.Key JAI_INSTANCE
          The JAI instance to use.
static Hints.ClassKey JTS_COORDINATE_SEQUENCE_FACTORY
          The CoordinateSequenceFactory instance to use.
static Hints.ClassKey JTS_GEOMETRY_FACTORY
          The GeometryFactory instance to use.
static Hints.Key JTS_PRECISION_MODEL
          The PrecisionModel instance to use.
static Hints.Key JTS_SRID
          The spatial reference ID for GeometryFactory.
static Hints.Key LENIENT_DATUM_SHIFT
          Tells if coordinate operations should be allowed even when a datum shift is required while no method is found applicable.
static Hints.ClassKey MATH_TRANSFORM_FACTORY
          The MathTransformFactory instance to use.
static Hints.Key MAX_ALLOWED_TILES
          Key to control the maximum allowed number of tiles that we will load.
static Hints.Key MOSAIC_LOCATION_ATTRIBUTE
          Key to control the name of the attribute that contains the location for the tiles in the mosaic index.
static Hints.Key OVERVIEW_POLICY
          Overview choosing policy.
static Hints.Key POSITION_FACTORY
          The PositionFactory instance to use.
static Hints.Key PRECISION
          The Precision to use in ISO geometry factories.
static Hints.Key PRIMITIVE_FACTORY
          The PrimitiveFactory instance to use.
static Hints.Key REPLACE_NON_GEOPHYSICS_VIEW
          Deprecated. Replaced by COVERAGE_PROCESSING_VIEW key with a ViewType.PHOTOGRAPHIC value.
static Hints.Key SAMPLE_DIMENSION_TYPE
          The SampleDimensionType to use.
static Hints.ClassKey STYLE_FACTORY
          The StyleFactory instance to use.
static Hints.Key TILE_ENCODING
          The tile encoder name (as a String value) to use during serialization of image data in a GridCoverage2D object.
static Hints.Key USE_JAI_IMAGEREAD
          Tells to the GridCoverageReader instances to read the image using the JAI ImageRead operation (leveraging on Deferred Execution Model, Tile Caching,...) or the direct ImageReader's read methods.
static Hints.Key VERSION
          Version number of the requested service.
 
Fields inherited from class RenderingHints
KEY_ALPHA_INTERPOLATION, KEY_ANTIALIASING, KEY_COLOR_RENDERING, KEY_DITHERING, KEY_FRACTIONALMETRICS, KEY_INTERPOLATION, KEY_RENDERING, KEY_STROKE_CONTROL, KEY_TEXT_ANTIALIASING, VALUE_ALPHA_INTERPOLATION_DEFAULT, VALUE_ALPHA_INTERPOLATION_QUALITY, VALUE_ALPHA_INTERPOLATION_SPEED, VALUE_ANTIALIAS_DEFAULT, VALUE_ANTIALIAS_OFF, VALUE_ANTIALIAS_ON, VALUE_COLOR_RENDER_DEFAULT, VALUE_COLOR_RENDER_QUALITY, VALUE_COLOR_RENDER_SPEED, VALUE_DITHER_DEFAULT, VALUE_DITHER_DISABLE, VALUE_DITHER_ENABLE, VALUE_FRACTIONALMETRICS_DEFAULT, VALUE_FRACTIONALMETRICS_OFF, VALUE_FRACTIONALMETRICS_ON, VALUE_INTERPOLATION_BICUBIC, VALUE_INTERPOLATION_BILINEAR, VALUE_INTERPOLATION_NEAREST_NEIGHBOR, VALUE_RENDER_DEFAULT, VALUE_RENDER_QUALITY, VALUE_RENDER_SPEED, VALUE_STROKE_DEFAULT, VALUE_STROKE_NORMALIZE, VALUE_STROKE_PURE, VALUE_TEXT_ANTIALIAS_DEFAULT, VALUE_TEXT_ANTIALIAS_OFF, VALUE_TEXT_ANTIALIAS_ON
 
Constructor Summary
Hints()
          Constructs an initially empty set of hints.
Hints(Map<? extends RenderingHints.Key,?> hints)
          Constructs a new object with keys and values initialized from the specified map (which may be null).
Hints(RenderingHints.Key key, Object value)
          Constructs a new object with the specified key/value pair.
Hints(RenderingHints.Key key1, Object value1, Object[] pairs)
          Deprecated. The Object[] argument was a kind of substitution for variable-length arguments. In order to avoid confusion, it is safer to use the later.
Hints(RenderingHints.Key key1, Object value1, RenderingHints.Key key2, Object value2)
          Constructs a new object with two key/value pair.
Hints(RenderingHints.Key key1, Object value1, RenderingHints.Key key2, Object value2, Object... pairs)
          Constructs a new object from key/value pair.
Hints(RenderingHints hints)
          Constructs a new object with keys and values initialized from the specified hints (which may be null).
 
Method Summary
 Hints clone()
          Returns a new map of hints with the same content than this map.
static Object getSystemDefault(RenderingHints.Key key)
          Returns the hint default value for the specified key.
static Object putSystemDefault(RenderingHints.Key key, Object value)
          Adds a hint value to the set of default hints.
static Object removeSystemDefault(RenderingHints.Key key)
          Removes the specified hints from the set of default hints.
static void scanSystemProperties()
          Notifies that system properties will need to be scanned for any property keys defined in the GeoTools class.
 String toString()
          Returns a string representation of the hints.
 
Methods inherited from class RenderingHints
add, clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values
 
Methods inherited from class Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

CRS_AUTHORITY_FACTORY

public static final Hints.ClassKey CRS_AUTHORITY_FACTORY
The CRSAuthorityFactory instance to use.

See Also:
org.geotools.referencing.FactoryFinder#getCRSAuthorityFactory

CS_AUTHORITY_FACTORY

public static final Hints.ClassKey CS_AUTHORITY_FACTORY
The CSAuthorityFactory instance to use.

See Also:
org.geotools.referencing.FactoryFinder#getCSAuthorityFactory

DATUM_AUTHORITY_FACTORY

public static final Hints.ClassKey DATUM_AUTHORITY_FACTORY
The DatumAuthorityFactory instance to use.

See Also:
org.geotools.referencing.FactoryFinder#getDatumAuthorityFactory

CRS_FACTORY

public static final Hints.ClassKey CRS_FACTORY
The CRSFactory instance to use.

See Also:
org.geotools.referencing.FactoryFinder#getCRSFactory

CS_FACTORY

public static final Hints.ClassKey CS_FACTORY
The CSFactory instance to use.

See Also:
org.geotools.referencing.FactoryFinder#getCSFactory

DATUM_FACTORY

public static final Hints.ClassKey DATUM_FACTORY
The DatumFactory instance to use.

See Also:
org.geotools.referencing.FactoryFinder#getDatumFactory

COORDINATE_OPERATION_FACTORY

public static final Hints.ClassKey COORDINATE_OPERATION_FACTORY
The CoordinateOperationFactory instance to use.

See Also:
org.geotools.referencing.FactoryFinder#getCoordinateOperationFactory

COORDINATE_OPERATION_AUTHORITY_FACTORY

public static final Hints.ClassKey COORDINATE_OPERATION_AUTHORITY_FACTORY
The CoordinateOperationAuthorityFactory instance to use.

See Also:
org.geotools.referencing.FactoryFinder#getCoordinateOperationAuthorityFactory

MATH_TRANSFORM_FACTORY

public static final Hints.ClassKey MATH_TRANSFORM_FACTORY
The MathTransformFactory instance to use.

See Also:
org.geotools.referencing.FactoryFinder#getMathTransformFactory

DEFAULT_COORDINATE_REFERENCE_SYSTEM

public static final Hints.Key DEFAULT_COORDINATE_REFERENCE_SYSTEM
The default CoordinateReferenceSystem to use. This is used by some factories capable to provide a default CRS when no one were explicitly specified by the user.

Since:
2.2

CRS_AUTHORITY_EXTRA_DIRECTORY

public static final Hints.FileKey CRS_AUTHORITY_EXTRA_DIRECTORY
Used to direct WKT CRS Authority to a directory containing extra definitions. The value should be an instance of File or String refering to an existing directory.

Filenames in the supplied directory should be of the form authority.properties where authority is the authority name space to use. For example the "epsg.properties" file contains extra CRS to add as new EPSG codes.

To set the directory on the command line:

 -D=path
 

Since:
2.4

EPSG_DATA_SOURCE

public static final Hints.Key EPSG_DATA_SOURCE
The data source name to lookup from JNDI when initializing the EPSG factory. Possible values:

To set on the command line:

 -D=jndiReference
 

Since:
2.4

DATUM_SHIFT_METHOD

public static final Hints.OptionKey DATUM_SHIFT_METHOD
The preferred datum shift method to use for coordinate operations. Valid values are "Molodenski", "Abridged_Molodenski" or "Geocentric". Other values may be supplied if a math transform exists for that name, but this is not guaranteed to work.

See Also:
org.geotools.referencing.FactoryFinder#getCoordinateOperationFactory

LENIENT_DATUM_SHIFT

public static final Hints.Key LENIENT_DATUM_SHIFT
Tells if coordinate operations should be allowed even when a datum shift is required while no method is found applicable. It may be for example that no Bursa Wolf parameters were found for a datum shift. The default value is FALSE, which means that coordinate operation factory throws an exception if such a case occurs. If this hint is set to TRUE, then the user is strongly encouraged to check the positional accuracy for every transformation created. If the set of positional accuracy contains DATUM_SHIFT_OMITTED, this means that an "ellipsoid shift" were applied without real datum shift method available, and the transformed coordinates may have one kilometer error. The application should warn the user (e.g. popup a message dialog box) in such case.

See Also:
org.geotools.referencing.FactoryFinder#getCoordinateOperationFactory

FORCE_LONGITUDE_FIRST_AXIS_ORDER

public static final Hints.Key FORCE_LONGITUDE_FIRST_AXIS_ORDER
Tells if the coordinate systems created by an authority factory should be forced to (longitude,latitude) axis order. This hint is especially useful for creating objects from EPSG codes. Most defined in the EPSG database use (latitude,longitude) axis order. Unfortunatly, many data sources available in the world uses the opposite axis order and still claim to use a CRS described by an EPSG code. This hint allows to handle such data.

This hint shall be passed to the FactoryFinder.getCRSAuthorityFactory(...) method. Whatever this hint is supported or not is authority dependent. In the default Geotools configuration, this hint is supported for the "EPSG" authority.

If this hint is not provided, then the default value depends on many factors including system properties and plugins available in the classpath. In Geotools implementation, the default value is usually FALSE with one exception: If the "org.geotools.referencing.forceXY" system property is set to true, then the default value is true at least for the default EPSG factory.

If both the above-cited system property and this hint are provided, then this hint has precedence. This allow axis order control on a data store basis, and keep the system-wide property as the default value only for cases where axis order is unspecified.

To set on the command line:

 -D=longitudeFirst
 

Since:
2.3
See Also:
org.geotools.referencing.FactoryFinder#getCSFactory, org.geotools.referencing.FactoryFinder#getCRSFactory, OrderedAxisAuthorityFactory, LongitudeFirstFactory
Tutorial:
The axis order issue

FORCE_AXIS_ORDER_HONORING

public static final Hints.Key FORCE_AXIS_ORDER_HONORING
Applies the FORCE_LONGITUDE_FIRST_AXIS_ORDER hint to some factories that usually ignore it. The axis order issue is of concern mostly to the "EPSG" name space. Codes in the "http://www.opengis.net/gml/srs/" or "urn:ogc" name space usually ignore the axis order hint, especially the later which is clearly defined by OGC - in theory users are not allowed to change its behavior. If nevertheless a user really need to change its behavior, then he must provides explicitly a comma separated list of authorities with this FORCE_AXIS_ORDER_HONORING hint in addition to setting the FORCE_LONGITUDE_FIRST_AXIS_ORDER hint.

Example: In order to apply the (longitude,latitude) axis order to "http://www.opengis.net/" and "urn:ogc" name spaces in addition to EPSG, use the following hints:

hints.put(FORCE_LONGITUDE_FIRST_AXIS_ORDER, Boolean.TRUE); hints.put(FORCE_AXIS_ORDER_HONORING, "http, urn");
Note that the application of (longitude,latitude) axis order to the "urn:ogc" name space is a clear violation of OGC specification.

Since:
2.4

FORCE_STANDARD_AXIS_DIRECTIONS

public static final Hints.Key FORCE_STANDARD_AXIS_DIRECTIONS
Tells if the coordinate systems created by an authority factory should be forced to standard axis directions. If true, then South axis directions are forced to North, West axis directions are forced to East, etc. If false, then the axis directions are left unchanged.

This hint shall be passed to the FactoryFinder.getCRSAuthorityFactory(...) method. Whatever this hint is supported or not is authority dependent.

Since:
2.3
See Also:
org.geotools.referencing.FactoryFinder#getCSFactory, org.geotools.referencing.FactoryFinder#getCRSFactory, OrderedAxisAuthorityFactory

FORCE_STANDARD_AXIS_UNITS

public static final Hints.Key FORCE_STANDARD_AXIS_UNITS
Tells if the coordinate systems created by an authority factory should be forced to standard axis units. If true, then all angular units are forced to degrees and linear units to meters. If false, then the axis units are left unchanged.

This hint shall be passed to the FactoryFinder.getCRSAuthorityFactory(...) method. Whatever this hint is supported or not is authority dependent.

Since:
2.3
See Also:
org.geotools.referencing.FactoryFinder#getCSFactory, org.geotools.referencing.FactoryFinder#getCRSFactory, OrderedAxisAuthorityFactory

VERSION

public static final Hints.Key VERSION
Version number of the requested service. This hint is used for example in order to get a CRS authority factory backed by a particular version of EPSG database. The value should be an instance of Version.

Since:
2.4

CRS

public static final Hints.Key CRS
The CoordinateReferenceSystem to use in ISO geometry factories.

Since:
2.5
See Also:
JTS_SRID

PRECISION

public static final Hints.Key PRECISION
The Precision to use in ISO geometry factories.

Since:
2.5
See Also:
JTS_PRECISION_MODEL

POSITION_FACTORY

public static final Hints.Key POSITION_FACTORY
The PositionFactory instance to use.

Since:
2.5

GEOMETRY_FACTORY

public static final Hints.Key GEOMETRY_FACTORY
The GeometryFactory instance to use.

Since:
2.5
See Also:
JTS_GEOMETRY_FACTORY

COMPLEX_FACTORY

public static final Hints.Key COMPLEX_FACTORY
The ComplexFactory instance to use.

Since:
2.5

AGGREGATE_FACTORY

public static final Hints.Key AGGREGATE_FACTORY
The AggregateFactory instance to use.

Since:
2.5

PRIMITIVE_FACTORY

public static final Hints.Key PRIMITIVE_FACTORY
The PrimitiveFactory instance to use.

Since:
2.5

GEOMETRY_VALIDATE

public static final Hints.Key GEOMETRY_VALIDATE
If true, geometry will be validated on creation. A value of false may speedup geometry creation at the cost of less safety.

Since:
2.5

JTS_GEOMETRY_FACTORY

public static final Hints.ClassKey JTS_GEOMETRY_FACTORY
The GeometryFactory instance to use.

See Also:
GEOMETRY_FACTORY, FactoryFinder.getGeometryFactory(org.geotools.factory.Hints)

JTS_COORDINATE_SEQUENCE_FACTORY

public static final Hints.ClassKey JTS_COORDINATE_SEQUENCE_FACTORY
The CoordinateSequenceFactory instance to use.

See Also:
FactoryFinder.getCoordinateSequenceFactory(org.geotools.factory.Hints)

JTS_PRECISION_MODEL

public static final Hints.Key JTS_PRECISION_MODEL
The PrecisionModel instance to use.

See Also:
FactoryFinder.getPrecisionModel(org.geotools.factory.Hints), PRECISION

JTS_SRID

public static final Hints.Key JTS_SRID
The spatial reference ID for GeometryFactory.

See Also:
FactoryFinder.getGeometryFactory(org.geotools.factory.Hints), CRS

FEATURE_FACTORY

public static Hints.ClassKey FEATURE_FACTORY
The FeatureFactory instance to use.

Since:
2.5
See Also:
CommonFactoryFinder.getFeatureFactory()

FEATURE_TYPE_FACTORY

public static Hints.ClassKey FEATURE_TYPE_FACTORY
The FeatureTypeFactory instance to use.

Since:
2.4
See Also:
CommonFactoryFinder.getFeatureTypeFactory()

FEATURE_LOCK_FACTORY

public static final Hints.ClassKey FEATURE_LOCK_FACTORY
The FeatureLockFactory instance to use.

Since:
2.4
See Also:
CommonFactoryFinder.getFeatureLockFactory(org.geotools.factory.Hints)

FEATURE_COLLECTIONS

public static final Hints.ClassKey FEATURE_COLLECTIONS
The FeatureCollections instance to use.

Since:
2.4
See Also:
CommonFactoryFinder.getFeatureCollections(org.geotools.factory.Hints)

FEATURE_TYPE_FACTORY_NAME

public static final Hints.Key FEATURE_TYPE_FACTORY_NAME
Deprecated. This hint controls FeatureTypeBuilder which is now deprecated
Used to provide the type name for the returned FeatureTypeFactory. Values should be instances of String.

Since:
2.4

FEATURE_DETACHED

public static final Hints.Key FEATURE_DETACHED
Whether the features returned by the feature collections should be considered detached from the datastore, that is, they are updatable without altering the backing store (makes sense only if features are kept in memory or if there is some transparent persistent mechanism in place, such as the Hibernate one)

Since:
2.4

FEATURE_2D

public static final Hints.Key FEATURE_2D
Request that the features returned by the feature collections should be 2D only. Can be used to prevent the request of the third ordinate when only two are going to be used.

Since:
2.4.1

GEOMETRY_DISTANCE

public static final Hints.Key GEOMETRY_DISTANCE
Asks a datastore having a vector pyramid (pre-generalized geometries) to return the geometry version whose points have been generalized less than the spefiedi distance (further generalization might be performed by the client in memory).

The geometries returned are supposed to be topologically valid.


GEOMETRY_GENERALIZATION

public static final Hints.Key GEOMETRY_GENERALIZATION
Asks a datastore to perform a topology preserving on the fly generalization of the geometries. The datastore will return geometries generalized at the specified distance.


GEOMETRY_SIMPLIFICATION

public static final Hints.Key GEOMETRY_SIMPLIFICATION
Asks a datastore to perform a non topology preserving on the fly generalization of the geometries (e.g., returning self crossing polygons as a result of the geoneralization is considered valid).


COORDINATE_DIMENSION

public static final Hints.Key COORDINATE_DIMENSION
The actual coordinate dimensions of the geometry (to be used in the GeometryDescriptor user map)


STYLE_FACTORY

public static final Hints.ClassKey STYLE_FACTORY
The StyleFactory instance to use.

Since:
2.4
See Also:
CommonFactoryFinder.getStyleFactory(org.geotools.factory.Hints)

ATTRIBUTE_TYPE_FACTORY

public static final Hints.ClassKey ATTRIBUTE_TYPE_FACTORY
The AttributeTypeFactory instance to use.

Since:
2.4
See Also:
CommonFactoryFinder#getAttributeTypeFactory

FILTER_FACTORY

public static final Hints.ClassKey FILTER_FACTORY
The FilterFactory instance to use.

Since:
2.4
See Also:
CommonFactoryFinder.getFilterFactory(org.geotools.factory.Hints)

GRID_COVERAGE_PROCESSOR

public static final Hints.Key GRID_COVERAGE_PROCESSOR
Deprecated. The GridCoverageProcessor interface is not yet stable. Avoid dependencies if possible.
The GridCoverageProcessor instance to use.


MAX_ALLOWED_TILES

public static final Hints.Key MAX_ALLOWED_TILES
Key to control the maximum allowed number of tiles that we will load. If this number is exceeded, i.e. we request an area which is too large instead of getting stuck with opening thousands of files we throw an error.

Since:
2.5

MOSAIC_LOCATION_ATTRIBUTE

public static final Hints.Key MOSAIC_LOCATION_ATTRIBUTE
Key to control the name of the attribute that contains the location for the tiles in the mosaic index.

Since:
2.5

USE_JAI_IMAGEREAD

public static final Hints.Key USE_JAI_IMAGEREAD
Tells to the GridCoverageReader instances to read the image using the JAI ImageRead operation (leveraging on Deferred Execution Model, Tile Caching,...) or the direct ImageReader's read methods.

Since:
2.4

OVERVIEW_POLICY

public static final Hints.Key OVERVIEW_POLICY
Overview choosing policy. The value most be one of {link #org.geotools.coverage.grid.io.OverviewPolicy} enumeration.

Since:
2.5

COVERAGE_PROCESSING_VIEW

public static final Hints.Key COVERAGE_PROCESSING_VIEW
Forces the grid coverage processor to perform operations on the specified view.

Some operation when called on a grid coverage tries to converts to geophysics view before to execute. The rationale behind this is that the other views are just the rendered version of a coverage data, and operations like interpolations have a physical meaning only when applied on the geophysics view (e.g. interpolate Sea Surface Temperature (SST) values, not the RGB values that colorize the temperature).

However, in some cases like when doing pure rendering of images, we might want to force operations to work on photographic view directly, even performing color expansions as needed. This can be accomplished by setting this hint to the desired view. Be aware that interpolations after color expansions may produce colors that do not accuratly represent the geophysical value.

Since:
2.5

REPLACE_NON_GEOPHYSICS_VIEW

public static final Hints.Key REPLACE_NON_GEOPHYSICS_VIEW
Deprecated. Replaced by COVERAGE_PROCESSING_VIEW key with a ViewType.PHOTOGRAPHIC value.
Since:
2.4

TILE_ENCODING

public static final Hints.Key TILE_ENCODING
The tile encoder name (as a String value) to use during serialization of image data in a GridCoverage2D object. This encoding is given to the SerializableRenderedImage constructor. Valid values include (but is not limited to) "raw", "gzip" and "jpeg".

Note: We recommend to avoid the "jpeg" codec for grid coverages.

Since:
2.3
See Also:
org.geotools.coverage.FactoryFinder#getGridCoverageFactory

JAI_INSTANCE

public static final Hints.Key JAI_INSTANCE
The JAI instance to use.


SAMPLE_DIMENSION_TYPE

public static final Hints.Key SAMPLE_DIMENSION_TYPE
The SampleDimensionType to use.


ASSOCIATION_TRAVERSAL_DEPTH

public static final Hints.Key ASSOCIATION_TRAVERSAL_DEPTH
The maximum number of associations traversed in a datastore query.

This maps directly to the traversalXlinkDepth parameter in a WFS query.


ASSOCIATION_PROPERTY

public static final Hints.Key ASSOCIATION_PROPERTY
The name of a property to traverse in a datastore query.

This maps directly to a xlinkPropertyName in a WFS query.


CACHE_POLICY

public static final Hints.OptionKey CACHE_POLICY
Policy to use for caching referencing objects. Valid values are:

Since:
2.5

CACHE_LIMIT

public static final Hints.IntegerKey CACHE_LIMIT
The recommended maximum number of referencing objects to hold in a authority factory.

Since:
2.5

AUTHORITY_MAX_ACTIVE

public static final Hints.IntegerKey AUTHORITY_MAX_ACTIVE
The maximum number of active authority factories. The default is the number of available processors plus one.

This hint is treated as an absolute limit for AbstractAuthorityMediator instances such as HsqlDialectEpsgMediator. As such this will be the absolute limit on the number of database connections the mediator will make use of.

When this limit it reached, code will be forced to block while waiting for a connection to become available.

When this value is non positive their is no limit to the number of active authority factories deployed.

Since:
2.5

AUTHORITY_MIN_IDLE

public static final Hints.IntegerKey AUTHORITY_MIN_IDLE
Minimum number of objects required before the evictor will begin removing objects. This value is also used by AUTHORITY_SOFTMIN_EVICT_IDLETIME to keep this many idle workers around.

In practice this value indicates the number of database connections the application will hold open "just in case".

Recomendations:

To agree with J2EE conventions you will want this value to be zero.

Since:
2.5

AUTHORITY_MAX_IDLE

public static final Hints.IntegerKey AUTHORITY_MAX_IDLE
The number of idle AuthorityFactories.

This hint is treated as a recommendation for AbstractAuthorityMediator instances such as HsqlDialectEpsgMediator. As such this will control the number of connections the mediator is comfortable having open.

If AUTHORITY_MAX_ACTIVE is set to 20, up to twenty connections will be used during heavy load. If the AUTHORITY_MAX_IDLE is set to 10, connections will be immediately reclaimed until only 10 are open. As these 10 remain idle for AUTHORITY_

When the amount of time specified by AUTHORITY_IDLE_WAIT is non zero Max idle controls the maximum number of objects that can sit idle in the pool at any time. When negative, there is no limit to the number of objects that may be idle at one time.

Since:
2.5

AUTHORITY_MIN_EVICT_IDLETIME

public static final Hints.IntegerKey AUTHORITY_MIN_EVICT_IDLETIME
When the evictor is run, if more time (in milliseconds) than the value in AUTHORITY_MIN_EVICT_IDLETIME has passed, then the worker is destroyed.

Since:
2.5

AUTHORITY_SOFTMIN_EVICT_IDLETIME

public static final Hints.IntegerKey AUTHORITY_SOFTMIN_EVICT_IDLETIME
When the evictor is run, workers which have been idle for more than this value will be destroyed if and only if the number of idle workers exceeds AUTHORITY_MIN_IDLE.

Since:
2.5

AUTHORITY_TIME_BETWEEN_EVICTION_RUNS

public static final Hints.IntegerKey AUTHORITY_TIME_BETWEEN_EVICTION_RUNS
Time in milliseconds to wait between eviction runs.

Since:
2.5

COMPARISON_TOLERANCE

public static final Hints.DoubleKey COMPARISON_TOLERANCE
Tolerance used in comparisons between floating point values. Two floating points A and B are considered the same if A * (1 - tol) <= B <= A * (1 + tol). The default value is 0, meaning the two doubles have to be exactly the same (a bit to bit comparison will be performed).

Since:
2.6
Constructor Detail

Hints

public Hints()
Constructs an initially empty set of hints.

Since:
2.5

Hints

public Hints(RenderingHints.Key key,
             Object value)
Constructs a new object with the specified key/value pair.

Parameters:
key - The key of the particular hint property.
value - The value of the hint property specified with key.

Hints

public Hints(RenderingHints.Key key1,
             Object value1,
             RenderingHints.Key key2,
             Object value2)
Constructs a new object with two key/value pair.

Parameters:
key1 - The key for the first pair.
value1 - The value for the first pair.
key2 - The key2 for the second pair.
value2 - The value2 for the second pair.
Since:
2.4

Hints

@Deprecated
public Hints(RenderingHints.Key key1,
                        Object value1,
                        Object[] pairs)
Deprecated. The Object[] argument was a kind of substitution for variable-length arguments. In order to avoid confusion, it is safer to use the later.

Constructs a new object with key/value pairs from an array.

Parameters:
key1 - The key for the first pair.
value1 - The value for the first pair.
pairs - An array containing additional pairs of keys and values.
Since:
2.4

Hints

public Hints(RenderingHints.Key key1,
             Object value1,
             RenderingHints.Key key2,
             Object value2,
             Object... pairs)
Constructs a new object from key/value pair.

Parameters:
key1 - The key for the first pair.
value1 - The value for the first pair.
key2 - The key2 for the second pair.
value2 - The value2 for the second pair.
pairs - Additional pairs of keys and values.
Since:
2.4

Hints

public Hints(Map<? extends RenderingHints.Key,?> hints)
Constructs a new object with keys and values initialized from the specified map (which may be null).

Parameters:
hints - A map of key/value pairs to initialize the hints, or null if the object should be empty.

Hints

public Hints(RenderingHints hints)
Constructs a new object with keys and values initialized from the specified hints (which may be null).

Parameters:
hints - A map of key/value pairs to initialize the hints, or null if the object should be empty.
Since:
2.5
Method Detail

clone

public Hints clone()
Returns a new map of hints with the same content than this map.

Overrides:
clone in class RenderingHints
Since:
2.5

scanSystemProperties

public static void scanSystemProperties()
Notifies that system properties will need to be scanned for any property keys defined in the GeoTools class. New values found (if any) will be added to the set of default hints. For example if the system property is defined, then the FORCE_LONGITUDE_FIRST_AXIS_ORDER hint will be added to the set of default hints.

This method is invoked automatically the first time it is needed. It usually don't need to be invoked explicitly, except if the system properties changed. The scan may not be performed immediately, but rather when needed at some later stage.

Since:
2.4

getSystemDefault

public static Object getSystemDefault(RenderingHints.Key key)
Returns the hint default value for the specified key.

Parameters:
key - The hints key.
Returns:
The value for the specified key, or null if the key did not have a mapping.
Since:
2.4

putSystemDefault

public static Object putSystemDefault(RenderingHints.Key key,
                                      Object value)
Adds a hint value to the set of default hints. Default hints can be added by call to this putDefaultHint method, to the GeoTools.init(org.geotools.factory.Hints) method or by system properties with keys defined by the String constants in the GeoTools class.

Parameters:
key - The hint key.
value - The hint value.
Returns:
The previous value of the specified key, or null if none.
Throws:
IllegalArgumentException - If Hints.Key#isCompatibleValue() returns false for the specified value.
Since:
2.4

removeSystemDefault

public static Object removeSystemDefault(RenderingHints.Key key)
Removes the specified hints from the set of default hints.

Parameters:
key - The hints key that needs to be removed.
Returns:
The value to which the key had previously been mapped, or null if the key did not have a mapping.
Since:
2.4

toString

public String toString()
Returns a string representation of the hints. This method formats the set of hints as a tree. If some system-wide default hints exist, they are formatted after those hints for completeness.

Overrides:
toString in class RenderingHints
Since:
2.4


Copyright © 1996-2009 Geotools. All Rights Reserved.