org.geotools.data.gtopo30
Class GTopo30FormatFactory

java.lang.Object
  org.geotools.data.gtopo30.GTopo30FormatFactory

All Implemented Interfaces:

Factory, GridFormatFactorySpi

public class GTopo30FormatFactory

extends java.lang.Object

implements GridFormatFactorySpi

DOCUMENT ME!

Author:

giannecchini TODO To change the template for this generated type comment go to Window - Preferences - Java - Code Style - Code Templates

Constructor Summary

GTopo30FormatFactory()

Method Summary

org.opengis.coverage.grid.Format	createFormat() Construct a live grid format using the params specifed.
java.util.Map	getImplementationHints() Map of hints (maybe unmodifiable) used by this factory to customize its use.
boolean	isAvailable() Test to see if this format is available, if it has all the appropriate libraries to construct a format.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GTopo30FormatFactory

public GTopo30FormatFactory()

Method Detail

createFormat

public org.opengis.coverage.grid.Format createFormat()

Description copied from interface: GridFormatFactorySpi

Construct a live grid format using the params specifed.

Specified by:

createFormat in interface GridFormatFactorySpi

Returns:

The created DataSource, this may be null if the required resource was not found or if insufficent parameters were given. Note that canProcess() should have returned false if the problem is to do with insuficent parameters.

isAvailable

public boolean isAvailable()

Description copied from interface: GridFormatFactorySpi

Test to see if this format is available, if it has all the appropriate libraries to construct a format.

Most datastores should return true, because geotools will distribute the appropriate libraries. Though it's not a bad idea for DataStoreFactories to check to make sure that the libraries are there.

Specified by:

isAvailable in interface GridFormatFactorySpi

Returns:

true if and only if this factory has all the appropriate jars on the classpath to handle a Format.

getImplementationHints

public java.util.Map getImplementationHints()

Description copied from interface: Factory

Map of hints (maybe unmodifiable) used by this factory to customize its use. This map is not guaranteed to contains all the hints supplied by the user; it may be only a subset. Consequently, hints provided here are usually not suitable for creating new factories, unless the implementation make some additional garantees (e.g. FactoryUsingVolatileDependencies).

The primary purpose of this method is to determine if an existing factory instance can be reused for a set of user-supplied hints. This method is invoked by FactoryRegistry in order to compare this factory's hints against user's hints. This is dependency introspection only; never invokes this method for creating new factories.

Keys are usually static constants from the Hints class, while values are instances of some key-dependent class. The key set must contains at least all hints impacting functionality. While the key set may contains all hints supplied by the user, it is recommended to limit the set to only the hints used by this particular factory instance. A minimal set will helps FactoryRegistry to compares only hints that matter and avoid the creation of unnecessary instances of this factory.

The hint values may be different than the one supplied by the user. If a user supplied a hint as a Class object, this method shall replace it by the actual instance used, if possible.

Implementations of this method are usually quite simple. For example if a datum authority factory uses an ordinary datum factory, its method could be implemented as below (note that we should not check if the datum factory is null, since key with null value is the expected behaviour in this case). Example:

 Map hints = new HashMap();
 hints.put(Hints.DATUM_FACTORY, datumFactory);
 return hints;
 

Specified by:

getImplementationHints in interface Factory

Returns:

The map of hints, or an empty map if none.