org.geotools.imageio.netcdf

Class AncillaryFileManager

Object

AncillaryFileManager

All Implemented Interfaces:

FileSetManager

public class AncillaryFileManager
extends Object
implements FileSetManager

A class used to store any auxiliary indexing information such as the low level indexer definition as well as the datastore properties configuration specifying where to build that index.

Since 14.x is it also possible to store the catalog into a PostGis based DB

Author:

Daniele Romagnoli, GeoSolutions SAS

Constructor Summary

Constructors

Constructor and Description
AncillaryFileManager(File netcdfFile, String indexFilePath)
AncillaryFileManager(File netcdfFile, String indexFilePath, String datastoreFilePath)

Method Summary

Modifier and Type	Method and Description
boolean	acceptsVariable(String varName)
Indexer.Coverages.Coverage	addCoverage(String varName)
void	addFile(String filePath) Add a file to the file set manager
void	addSlice(Slice2DIndex variableIndex)
static String	convertToHex(byte[] data)
void	dispose() Dispose the Manager
Name	getCoverageName(String varName) Return a Name representation of the coverage name
List<Name>	getCoveragesNames() Get the list of Names for the underlying coverage list
DataStoreConfiguration	getDatastoreConfiguration() Create the DataStoreConfiguration using the external datastoreIndexFile if provided, or the H2 based default.
File	getDatastoreIndexFile()
File	getDestinationDir()
File	getIndexerFile()
String	getParameter(String parameterKey)
boolean	getParameterAsBoolean(String parameterKey)
Slice2DIndex	getSlice2DIndex(int imageIndex) Return a Slice2DIndex related to the provided imageIndex
File	getSlicesIndexFile()
String	getTypeName(String coverageName)
protected void	initIndexer() Retrieve basic indexer properties by scanning the indexer XML instance.
void	initSliceManager()
boolean	isImposedSchema()
List<String>	list() Return the list of all the files currently added to the manager
void	purge() Remove all the files from the manager (An implementation may also physically remove all the files)
void	removeFile(String filePath) Remove a file from the manager (An implementation may also physically remove the file)
void	resetSliceManager()
String	setSchema(Indexer.Coverages.Coverage coverage, String schemaName, String schemaDef) Add the default schema to this coverage
void	writeToDisk() Write indexer to disk

Methods inherited from class Object

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

Constructor Detail

AncillaryFileManager

public AncillaryFileManager(File netcdfFile,
                            String indexFilePath)
                     throws IOException,
                            JAXBException,
                            NoSuchAlgorithmException

Throws:

IOException

JAXBException

NoSuchAlgorithmException

AncillaryFileManager

public AncillaryFileManager(File netcdfFile,
                            String indexFilePath,
                            String datastoreFilePath)
                     throws IOException,
                            JAXBException,
                            NoSuchAlgorithmException

Throws:

IOException

JAXBException

NoSuchAlgorithmException

Method Detail

writeToDisk

public void writeToDisk()
                 throws IOException,
                        JAXBException

Write indexer to disk

Throws:

IOException

JAXBException -

TODO: Need to check for thread safety

getCoverageName

public Name getCoverageName(String varName)

Return a Name representation of the coverage name

Parameters:

varName -

Returns:

dispose

public void dispose()

Dispose the Manager

getSlice2DIndex

public Slice2DIndex getSlice2DIndex(int imageIndex)
                             throws IOException

Return a Slice2DIndex related to the provided imageIndex

Parameters:

imageIndex -

Returns:

Throws:

IOException

getSlicesIndexFile

public File getSlicesIndexFile()

getIndexerFile

public File getIndexerFile()

getDestinationDir

public File getDestinationDir()

getDatastoreIndexFile

public File getDatastoreIndexFile()

addSlice

public void addSlice(Slice2DIndex variableIndex)

addCoverage

public Indexer.Coverages.Coverage addCoverage(String varName)

initSliceManager

public void initSliceManager()
                      throws IOException

Throws:

IOException

resetSliceManager

public void resetSliceManager()
                       throws IOException

Throws:

IOException

getCoveragesNames

public List<Name> getCoveragesNames()

Get the list of Names for the underlying coverage list

Returns:

initIndexer

protected void initIndexer()
                    throws JAXBException

Retrieve basic indexer properties by scanning the indexer XML instance.

Throws:

JAXBException

getTypeName

public String getTypeName(String coverageName)

setSchema

public String setSchema(Indexer.Coverages.Coverage coverage,
                        String schemaName,
                        String schemaDef)

Add the default schema to this coverage

Parameters:

coverage -

Returns:

acceptsVariable

public boolean acceptsVariable(String varName)

Parameters:

varName -

Returns:

isImposedSchema

public boolean isImposedSchema()

addFile

public void addFile(String filePath)

Description copied from interface: FileSetManager

Add a file to the file set manager

Specified by:

addFile in interface FileSetManager

list

public List<String> list()

Description copied from interface: FileSetManager

Return the list of all the files currently added to the manager

Specified by:

list in interface FileSetManager

removeFile

public void removeFile(String filePath)

Description copied from interface: FileSetManager

Remove a file from the manager (An implementation may also physically remove the file)

Specified by:

removeFile in interface FileSetManager

purge

public void purge()

Description copied from interface: FileSetManager

Remove all the files from the manager (An implementation may also physically remove all the files)

Specified by:

purge in interface FileSetManager

convertToHex

public static String convertToHex(byte[] data)

getDatastoreConfiguration

public DataStoreConfiguration getDatastoreConfiguration()
                                                 throws IOException

Create the DataStoreConfiguration using the external datastoreIndexFile if provided, or the H2 based default.

Returns:

Throws:

IOException

getParameter

public String getParameter(String parameterKey)

getParameterAsBoolean

public boolean getParameterAsBoolean(String parameterKey)