org.locationtech.geowave.datastore.filesystem

Interface FileSystemDataFormatter.DataIndexFormatter

Enclosing interface:

FileSystemDataFormatter

public static interface FileSystemDataFormatter.DataIndexFormatter

Method Summary

Modifier and Type	Method and Description
byte[]	getDataId(String fileName, String typeName) Get the data ID for a given file name.
default String	getDirectoryName(String typeName) Gives the formatter an opportunity to override the default directory for the data index with this type name.
byte[]	getFileContents(String typeName, byte[] dataId, GeoWaveValue value) When using secondary indexing, this is called for storing the data values
String	getFileName(String typeName, byte[] dataId) When using secondary indexing, this is called for storing the data values
GeoWaveValue	getValue(String fileName, String typeName, byte[] dataId, byte[] fileContents) Get the geowave value for a given file name and file contents.

Method Detail

getDataId

byte[] getDataId(String fileName,
                 String typeName)

Get the data ID for a given file name. The type name is also provided. This is the inverse of getting the file name for a data ID.

Parameters:

fileName - the file name

typeName - the type name

Returns:

the data ID

getValue

GeoWaveValue getValue(String fileName,
                      String typeName,
                      byte[] dataId,
                      byte[] fileContents)

Get the geowave value for a given file name and file contents. The type name is also provided. This is the inverse of formatting the data.

Parameters:

fileName - the file name

typeName - the type name

dataId - the data ID

fileContents - the contents of the file

Returns:

the GeoWaveValue for the formatted data

getFileName

String getFileName(String typeName,
                   byte[] dataId)

When using secondary indexing, this is called for storing the data values

Parameters:

typeName - the DataTypeAdapter type name

dataId - the data ID

Returns:

the file name to use for this data ID

getFileContents

byte[] getFileContents(String typeName,
                       byte[] dataId,
                       GeoWaveValue value)

When using secondary indexing, this is called for storing the data values

Parameters:

typeName - the DataTypeAdapter type name

dataId - the data ID

value - the value

Returns:

the expected contents of the file according to this format

getDirectoryName

default String getDirectoryName(String typeName)

Gives the formatter an opportunity to override the default directory for the data index with this type name. Each data index *must* have a unique directory per type name for the system to function properly. Java NIO is used to resolve this name relative to the filesystem data store base directory, so if proper path separators are used for Java NIO to resolve nested directories, they can be specified as well. GeoWave will ensure directories are created prior to writing data

Parameters:

typeName - the type name

Returns:

the directory name