|
||||||||||
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES |
See:
Description
Interface Summary | |
---|---|
BufferedFactory | A marker interface for factories that are buffering their objects in some way. |
Factory | Base interface for Geotools factories (i.e. |
FactoryIteratorProvider | Provides iterators over factories of specified categories. |
FactoryUsingVolatileDependencies | Deprecated. This class should be a marker interface instead of an AbstractFactory
subclass. |
OptionalFactory | An optional factory that may not be available in all configurations. |
Class Summary | |
---|---|
AbstractFactory | Skeletal implementation of factories. |
BasicFactories | Defines a common abstraction for getting the different factories. |
CommonFactoryFinder | Defines static methods used to access the application's default implementation for some common factories. |
FactoryCreator | A factory registry capable to creates factories if no appropriate instance was found in the registry. |
FactoryFinder | Base class for factory finders. |
FactoryRegistry | A registry for factories, organized by categories (usualy by interface). |
GeoTools | Static methods relative to the global GeoTools configuration. |
Hints | A set of hints providing control on factories to be used. |
Hints.ClassKey | A key for value that may be specified either as instance of T , or as
Class<T> . |
Hints.DoubleKey | A hint used to capture a configuration setting as double. |
Hints.FileKey | Key for hints to be specified as a File . |
Hints.IntegerKey | A hint used to capture a configuration setting as an integer. |
Hints.Key | The type for keys used to control various aspects of the factory creation. |
Hints.OptionKey | Key that allows the choice of several options. |
Exception Summary | |
---|---|
FactoryNotFoundException | Thrown when a factory can't be found in the registery. |
FactoryRegistryException | Thrown when a factory can't be found or can't be instantiate. |
RecursiveSearchException | Thrown when FactoryRegistry is invoked recursively for the same category. |
Utility classes which enable dynamic binding to factory implementations at runtime.
Because Geotools core API consists almost exclusively of interfaces (including GeoAPI), factories play a role in how developers use the API. Although the interfaces that are declared in GeoAPI are implemented in various Geotools packages you should not use those classes directly. Instead you should use factories.
J2SE's ServiceRegistry
provides a general
way (even if it is defined in a javax.imageio
subpackage) to instantiate and
manage factories (also called providers). Each factory implementation should be declared
in META-INF/services
directory, usually bundled in every JAR file. For example
if a JAR file provides one or more DatumFactory
implementations, then it must provide the following file:
META-INF/services/org.opengis.referencing.datum.DatumFactory
with a content similar to the one below:
com.mycompany.MyDatumFactory1 com.mycompany.MyDatumFactory2 com.mycompany.MyDatumFactory3
The ordering is initially unspecified. Users can
set an ordering
explicitly themselves, or implementations can do that automatically
on registration.
The AbstractFactory
class provides a simple way to setup ordering
on registration on the basis of a priority
number.
If a user wants a specific implementation, he can
iterates through registered ones
and pickup the desired implementation himself. An alternative is to bundle the criterions in a
map of hints and lets the registry selects an implementation
accordingly. This later functionality is not provided by the standard ServiceRegistry
,
but is provided by Geotools's FactoryRegistry
extension. This class extends
the service registry API with the following functionalities:
A scanForPlugins()
method that scans for plugins in the
registry class loader, the
thread context class loader and the
system class loader.
Additionally, scanForPlugins()
looks for any implementation specified as
system property.
Filters out automatically optional factories when they are not available.
When more than one implementation is available for the same Factory
subinterface, an optional set of hints can specifies the criterions that the
desired implementation must meets. If a factory implementation depends on other factories, the dependencies hints
are checked recursively.
Optionally, if no factory matches the given hints, a new instance can be automatically created.
Note that the hints, if provided, don't need to apply
directly to the requested factory category. They may apply indirectly through some dependency. A typical example is
a request for any GeometryFactory
instance, providing that this instance uses a
particular CoordinateSequenceFactory
implementation.
|
||||||||||
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES |