|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ObjectRenderingHints
Hints
public class Hints
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.
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.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.Key |
COMPLEX_FACTORY
The ComplexFactory instance to use. |
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 |
IGNORE_COVERAGE_OVERVIEW
Deprecated. use the correct OVERVIEW_POLICY instead. |
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 Object |
VALUE_OVERVIEW_POLICY_IGNORE
Deprecated. Moved to OverviewPolicy.IGNORE . |
static Object |
VALUE_OVERVIEW_POLICY_NEAREST
Deprecated. Moved to OverviewPolicy.NEAREST . |
static Object |
VALUE_OVERVIEW_POLICY_QUALITY
Deprecated. Moved to OverviewPolicy.QUALITY . |
static Object |
VALUE_OVERVIEW_POLICY_SPEED
Deprecated. Moved to OverviewPolicy.SPEED . |
static Hints.Key |
VERSION
Version number of the requested service. |
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 |
---|
public static final Hints.ClassKey CRS_AUTHORITY_FACTORY
CRSAuthorityFactory
instance to use.
org.geotools.referencing.FactoryFinder#getCRSAuthorityFactory
public static final Hints.ClassKey CS_AUTHORITY_FACTORY
CSAuthorityFactory
instance to use.
org.geotools.referencing.FactoryFinder#getCSAuthorityFactory
public static final Hints.ClassKey DATUM_AUTHORITY_FACTORY
DatumAuthorityFactory
instance to use.
org.geotools.referencing.FactoryFinder#getDatumAuthorityFactory
public static final Hints.ClassKey CRS_FACTORY
CRSFactory
instance to use.
org.geotools.referencing.FactoryFinder#getCRSFactory
public static final Hints.ClassKey CS_FACTORY
CSFactory
instance to use.
org.geotools.referencing.FactoryFinder#getCSFactory
public static final Hints.ClassKey DATUM_FACTORY
DatumFactory
instance to use.
org.geotools.referencing.FactoryFinder#getDatumFactory
public static final Hints.ClassKey COORDINATE_OPERATION_FACTORY
CoordinateOperationFactory
instance to use.
org.geotools.referencing.FactoryFinder#getCoordinateOperationFactory
public static final Hints.ClassKey COORDINATE_OPERATION_AUTHORITY_FACTORY
CoordinateOperationAuthorityFactory
instance
to use.
org.geotools.referencing.FactoryFinder#getCoordinateOperationAuthorityFactory
public static final Hints.ClassKey MATH_TRANSFORM_FACTORY
MathTransformFactory
instance to use.
org.geotools.referencing.FactoryFinder#getMathTransformFactory
public static final Hints.Key DEFAULT_COORDINATE_REFERENCE_SYSTEM
CoordinateReferenceSystem
to use. This is used by some factories capable to provide a default CRS
when no one were explicitly specified by the user.
public static final Hints.FileKey CRS_AUTHORITY_EXTRA_DIRECTORY
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
public static final Hints.Key EPSG_DATA_SOURCE
String
- used with JNDI to locate datasource. This hint has no effect if
there is no JNDI initial context setup.To set on the command line:
-D=jndiReference
public static final Hints.OptionKey DATUM_SHIFT_METHOD
"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.
org.geotools.referencing.FactoryFinder#getCoordinateOperationFactory
public static final Hints.Key LENIENT_DATUM_SHIFT
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.
org.geotools.referencing.FactoryFinder#getCoordinateOperationFactory
public static final Hints.Key FORCE_LONGITUDE_FIRST_AXIS_ORDER
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
org.geotools.referencing.FactoryFinder#getCSFactory
,
org.geotools.referencing.FactoryFinder#getCRSFactory
,
OrderedAxisAuthorityFactory
,
LongitudeFirstFactory
public static final Hints.Key FORCE_AXIS_ORDER_HONORING
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.
public static final Hints.Key FORCE_STANDARD_AXIS_DIRECTIONS
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.
org.geotools.referencing.FactoryFinder#getCSFactory
,
org.geotools.referencing.FactoryFinder#getCRSFactory
,
OrderedAxisAuthorityFactory
public static final Hints.Key FORCE_STANDARD_AXIS_UNITS
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.
org.geotools.referencing.FactoryFinder#getCSFactory
,
org.geotools.referencing.FactoryFinder#getCRSFactory
,
OrderedAxisAuthorityFactory
public static final Hints.Key VERSION
Version
.
public static final Hints.Key CRS
CoordinateReferenceSystem
to use in
ISO geometry factories.
JTS_SRID
public static final Hints.Key PRECISION
Precision
to use in ISO geometry factories.
JTS_PRECISION_MODEL
public static final Hints.Key POSITION_FACTORY
PositionFactory
instance to use.
public static final Hints.Key GEOMETRY_FACTORY
GeometryFactory
instance to use.
JTS_GEOMETRY_FACTORY
public static final Hints.Key COMPLEX_FACTORY
ComplexFactory
instance to use.
public static final Hints.Key AGGREGATE_FACTORY
AggregateFactory
instance to use.
public static final Hints.Key PRIMITIVE_FACTORY
PrimitiveFactory
instance to use.
public static final Hints.Key GEOMETRY_VALIDATE
true
, geometry will be validated on creation. A value of false
may speedup geometry creation at the cost of less safety.
public static final Hints.ClassKey JTS_GEOMETRY_FACTORY
GeometryFactory
instance to use.
GEOMETRY_FACTORY
,
FactoryFinder.getGeometryFactory(org.geotools.factory.Hints)
public static final Hints.ClassKey JTS_COORDINATE_SEQUENCE_FACTORY
CoordinateSequenceFactory
instance to use.
FactoryFinder.getCoordinateSequenceFactory(org.geotools.factory.Hints)
public static final Hints.Key JTS_PRECISION_MODEL
PrecisionModel
instance to use.
FactoryFinder.getPrecisionModel(org.geotools.factory.Hints)
,
PRECISION
public static final Hints.Key JTS_SRID
GeometryFactory
.
FactoryFinder.getGeometryFactory(org.geotools.factory.Hints)
,
CRS
public static Hints.ClassKey FEATURE_FACTORY
FeatureFactory
instance to use.
CommonFactoryFinder.getFeatureFactory()
public static Hints.ClassKey FEATURE_TYPE_FACTORY
FeatureTypeFactory
instance to use.
CommonFactoryFinder.getFeatureTypeFactory()
public static final Hints.ClassKey FEATURE_LOCK_FACTORY
FeatureLockFactory
instance to use.
CommonFactoryFinder.getFeatureLockFactory(org.geotools.factory.Hints)
public static final Hints.ClassKey FEATURE_COLLECTIONS
FeatureCollections
instance to use.
CommonFactoryFinder.getFeatureCollections(org.geotools.factory.Hints)
public static final Hints.Key FEATURE_TYPE_FACTORY_NAME
FeatureTypeFactory
. Values should
be instances of String
.
public static final Hints.Key FEATURE_DETACHED
public static final Hints.Key FEATURE_2D
public static final Hints.Key GEOMETRY_DISTANCE
The geometries returned are supposed to be topologically valid.
public static final Hints.Key GEOMETRY_GENERALIZATION
public static final Hints.Key GEOMETRY_SIMPLIFICATION
public static final Hints.ClassKey STYLE_FACTORY
StyleFactory
instance to use.
CommonFactoryFinder.getStyleFactory(org.geotools.factory.Hints)
public static final Hints.ClassKey ATTRIBUTE_TYPE_FACTORY
AttributeTypeFactory
instance to use.
CommonFactoryFinder#getAttributeTypeFactory
public static final Hints.ClassKey FILTER_FACTORY
FilterFactory
instance to use.
CommonFactoryFinder.getFilterFactory(org.geotools.factory.Hints)
public static final Hints.Key GRID_COVERAGE_PROCESSOR
GridCoverageProcessor
interface is not yet
stable. Avoid dependencies if possible.GridCoverageProcessor
instance to use.
public static final Hints.Key IGNORE_COVERAGE_OVERVIEW
OVERVIEW_POLICY
instead.GridCoverageReader
instances to ignore
the built-in overviews when creating a org.opengis.coverage.grid.GridCoverage2D
object during a read. This hints also implied that no decimation on reading is performed.
public static final Hints.Key MAX_ALLOWED_TILES
public static final Hints.Key MOSAIC_LOCATION_ATTRIBUTE
public static final Hints.Key USE_JAI_IMAGEREAD
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.
public static Object VALUE_OVERVIEW_POLICY_QUALITY
OverviewPolicy.QUALITY
.
public static Object VALUE_OVERVIEW_POLICY_IGNORE
OverviewPolicy.IGNORE
.
public static Object VALUE_OVERVIEW_POLICY_NEAREST
OverviewPolicy.NEAREST
.
public static Object VALUE_OVERVIEW_POLICY_SPEED
OverviewPolicy.SPEED
.
public static final Hints.Key OVERVIEW_POLICY
public static final Hints.Key COVERAGE_PROCESSING_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.
public static final Hints.Key REPLACE_NON_GEOPHYSICS_VIEW
COVERAGE_PROCESSING_VIEW
key with a
ViewType.PHOTOGRAPHIC
value.public static final Hints.Key TILE_ENCODING
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.
org.geotools.coverage.FactoryFinder#getGridCoverageFactory
public static final Hints.Key JAI_INSTANCE
JAI
instance to use.
public static final Hints.Key SAMPLE_DIMENSION_TYPE
SampleDimensionType
to use.
public static final Hints.Key ASSOCIATION_TRAVERSAL_DEPTH
This maps directly to the traversalXlinkDepth
parameter in a WFS query.
public static final Hints.Key ASSOCIATION_PROPERTY
This maps directly to a xlinkPropertyName
in a WFS query.
public static final Hints.OptionKey CACHE_POLICY
"weak"
for holding values through weak references. This option does not actually cache the objects since the garbage
collector cleans weak references aggressively, but it allows sharing the instances
already created and still in use.
public static final Hints.IntegerKey CACHE_LIMIT
public static final Hints.IntegerKey AUTHORITY_MAX_ACTIVE
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.
public static final Hints.IntegerKey AUTHORITY_MIN_IDLE
In practice this value indicates the number of database connections the application will hold open "just in case".
Recomendations:
public static final Hints.IntegerKey AUTHORITY_MAX_IDLE
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.
public static final Hints.IntegerKey AUTHORITY_MIN_EVICT_IDLETIME
AUTHORITY_MIN_EVICT_IDLETIME
has passed, then the worker is destroyed.
public static final Hints.IntegerKey AUTHORITY_SOFTMIN_EVICT_IDLETIME
public static final Hints.IntegerKey AUTHORITY_TIME_BETWEEN_EVICTION_RUNS
Constructor Detail |
---|
public Hints()
public Hints(RenderingHints.Key key, Object value)
key
- The key of the particular hint property.value
- The value of the hint property specified with key
.public Hints(RenderingHints.Key key1, Object value1, RenderingHints.Key key2, Object value2)
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.@Deprecated public Hints(RenderingHints.Key key1, Object value1, Object[] pairs)
Object[]
argument was a kind of substitution for variable-length
arguments. In order to avoid confusion, it is safer to use the later.
key1
- The key for the first pair.value1
- The value for the first pair.pairs
- An array containing additional pairs of keys and values.public Hints(RenderingHints.Key key1, Object value1, RenderingHints.Key key2, Object value2, Object... pairs)
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.public Hints(Map<? extends RenderingHints.Key,?> hints)
hints
- A map of key/value pairs to initialize the hints, or
null
if the object should be empty.public Hints(RenderingHints hints)
hints
- A map of key/value pairs to initialize the hints, or
null
if the object should be empty.Method Detail |
---|
public Hints clone()
clone
in class RenderingHints
public static void scanSystemProperties()
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.
public static Object getSystemDefault(RenderingHints.Key key)
key
- The hints key.
null
if the key did not have a mapping.public static Object putSystemDefault(RenderingHints.Key key, Object value)
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.
key
- The hint key.value
- The hint value.
null
if none.
IllegalArgumentException
- If Hints.Key#isCompatibleValue()
returns false
for the specified value.public static Object removeSystemDefault(RenderingHints.Key key)
key
- The hints key that needs to be removed.
null
if the key did not have a mapping.public String toString()
toString
in class RenderingHints
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |