oracle.spatial.hadoop.rasterapi.core.beans

Class MosaicConfiguration

java.lang.Object

oracle.spatial.hadoop.rasterapi.core.beans.MosaicConfiguration

public class MosaicConfiguration
extends java.lang.Object

Represents the configuration for the mosaic output, includes the resolution, format, datatype, coordinates , required processing and every single feature of the expected mosaic output.

Constructor Summary

Constructors

Constructor and Description
MosaicConfiguration() Class constructor.

Method Summary

Modifier and Type	Method and Description
void	addProcessingClass(java.lang.String processingClass) Adds a processing class to this mosaic request
void	addReduceProcessingClass(java.lang.String reduceProcessingClass) Adds a reduce processing class to this mosaic request
java.lang.String	getCompactMosaic() Gets a String representing this mosaic request configuration, used to set it to Job configuration.
java.lang.String	getDirectory() Gets the output Filesystem for this request.
java.lang.String	getFileName() Gets the file name fot tue ouput mosaic
java.lang.String	getFileSystem() Gets the Filesystem where mosaic will be stored.
java.lang.String	getFormat() Gets the format of the resulting image, like tiff, geotiff.
int	getHeight() Gets the height value for this mosaic request.
java.lang.String	getLayers() Get the order of appearance of bands in output
java.lang.String	getNoData() Gets the NODATA color values for this mosaic.
java.lang.String	getOrder() Gets the order for the pieces in this mosaic request.
java.lang.String	getOrderAlgorithm() Gets the the ordering algorithm for the images in this request.
java.lang.String	getPixelType() Gets the pixel type allowed for this mosaic's output.
double	getPixelXWidth() Gets the width for pixel values in X in this request.
double	getPixelYWidth() Gets the width for pixel values in Y in this request.
java.lang.String	getProcessingClasses() Gets the processing classes for the related input.
java.lang.String	getReduceProcessingClasses() Gets the reducer processing classes for the related input.
java.lang.String	getSrid() Gets the SRID value for this mosaic request.
java.lang.String	getTemporaryFolder() Gets the temporary output folder where partial output is stored when HDFS output is requested
int	getWidth() Gets the width value for this mosaic request.
boolean	isDeleteLocalFile() Gets the flag that indicates if the temporary output file will be deleted or not after is loaded in HDFS
boolean	isExecuteMosaic() Gets value to indicate if mosaic operation will be process or not, is is true by default
void	setBands(int bands) Sets the number of bands for this mosaic request
void	setDeleteLocalFile(boolean deleteLocalFile) Sets the flag that indicates if the temporary output file will be deleted or not after is loaded in HDFS
void	setDirectory(java.lang.String directory) Sets the directory where the mosaic's ouput will be stored, it can be in NFS for regular FileSystem or in HDFS for Hadoop storage, depending on the setting for mosaics FileSystem.
void	setExecuteMosaic(boolean executeMosaic) Sets value to indicate if mosaic operation will be process or not, is is true by default
void	setFileName(java.lang.String fileName) Sets the file name fot tue ouput mosaic
void	setFileSystem(java.lang.String fileSystem) Sets the Filesystem where mosaic will be stored
void	setFormat(java.lang.String format) Sets the format of the resulting image, like GTIFF, JPEG, PNG, etc.
void	setHeight(int height) Sets the height for this mosaic request.
void	setLayers(java.lang.String layers) Sets the order of appearance of bands in output, if the list contains more bands that the ones configured for output, the rest are ignored.
void	setNoData(java.lang.String noData) Sets the color for the NODATA values in the output.
void	setOrder(java.lang.String order) Sets the order for the pieces in this mosaic request.
void	setOrderAlgorithm(java.lang.String orderAlgorithm) Sets the ordering algorithm for the images in this request.
void	setPixelType(java.lang.String pixelType) Sets the pixel type allowed for this mosaic and supported by gdal.
void	setPixelXWidth(double pixelXWidth) Sets the width for pixel values in X in this request.
void	setPixelYWidth(double pixelYWidth) Sets the width for pixel values in Y in this request.
void	setProcessingClasses(java.lang.String processingClasses) Sets the processing classes for the related input.
void	setReduceProcessingClasses(java.lang.String reduceProcessingClasses) Sets the reducer processing classes for the related input.
void	setSrid(java.lang.String srid) Sets the SRID for this mosaic request.
void	setTemporaryFolder(java.lang.String temporaryFolder) Sets the temporary folder used when HDFS output is requested to store partial FS output before calling image loader job.
void	setUpperLeftX(double upperLeftX) Sets the upper left point in X for this mosaic request.
void	setUpperLeftY(double upperLeftY) Sets the upper left point in Y for this mosaic request
void	setWidth(int width) Sets the width for this mosaic request.

Methods inherited from class java.lang.Object

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

Constructor Detail

MosaicConfiguration

public MosaicConfiguration()

Class constructor.

Method Detail

setSrid

public void setSrid(java.lang.String srid)

Sets the SRID for this mosaic request.

Parameters:

srid - the value to set in this SRID.

getSrid

public java.lang.String getSrid()

Gets the SRID value for this mosaic request.

Returns:

the SRID value for this mosaic request.

setWidth

public void setWidth(int width)

Sets the width for this mosaic request.

Parameters:

width - the value to set in this mosaic's width.

setExecuteMosaic

public void setExecuteMosaic(boolean executeMosaic)

Sets value to indicate if mosaic operation will be process or not, is is true by default

Parameters:

executeMosaic - true if mosaic operation will be processed, false otherwise

isExecuteMosaic

public boolean isExecuteMosaic()

Gets value to indicate if mosaic operation will be process or not, is is true by default

Returns:

true if mosaic operation will be processed, false otherwise

getWidth

public int getWidth()

Gets the width value for this mosaic request.

Returns:

the width value for this mosaic request.

setHeight

public void setHeight(int height)

Sets the height for this mosaic request.

Parameters:

height - the value to set in this mosaic's height.

getHeight

public int getHeight()

Gets the height value for this mosaic request.

Returns:

the height value for this mosaic request.

setUpperLeftX

public void setUpperLeftX(double upperLeftX)

Sets the upper left point in X for this mosaic request.

Parameters:

upperLeftX - the value to set in this mosaic's upper left X point.

setUpperLeftY

public void setUpperLeftY(double upperLeftY)

Sets the upper left point in Y for this mosaic request

Parameters:

upperLeftY - the value to set in this mosaic´s upper left Y point.

setOrder

public void setOrder(java.lang.String order)

Sets the order for the pieces in this mosaic request. Ascendant or Descendant, use RasterProcessorJob.ASC or RasterProcessorJob.DESC.

Parameters:

order - the order for this mosaic request.

getOrder

public java.lang.String getOrder()

Gets the order for the pieces in this mosaic request.

Returns:

the numeric value for the order of this request.

setFormat

public void setFormat(java.lang.String format)

Sets the format of the resulting image, like GTIFF, JPEG, PNG, etc. Valid for all GDAL wrie supported formats.

Parameters:

format - the value for the mosaic's output format.

getFormat

public java.lang.String getFormat()

Gets the format of the resulting image, like tiff, geotiff.

Returns:

the format the value for the mosaic's output format.

setNoData

public void setNoData(java.lang.String noData)

Sets the color for the NODATA values in the output. It must start with "#" followed by the two characters representing a color, these must be set per band. For example, for a 3 band image: #FFFFFF.

Parameters:

noData - the NODATA value for the output's pixels. A couple of values per band is requested.

getNoData

public java.lang.String getNoData()

Gets the NODATA color values for this mosaic.

Returns:

the NODATA value for the output's pixels.

setPixelType

public void setPixelType(java.lang.String pixelType)

Sets the pixel type allowed for this mosaic and supported by gdal. Any other pixel type images are discarded from the output. A value such as gdalconst.GDT_Byte, gdalconst.GDT_Int16, ...

Parameters:

pixelType - the pixel type allowed in the ouput.

See Also:

gdalconstConstants class from GDT_Byte to GDT_CFloat64.

getPixelType

public java.lang.String getPixelType()

Gets the pixel type allowed for this mosaic's output.

Returns:

the pixel type for this mosaic request.

getPixelXWidth

public double getPixelXWidth()

Gets the width for pixel values in X in this request.

Returns:

the width for pixel values in X.

getPixelYWidth

public double getPixelYWidth()

Gets the width for pixel values in Y in this request.

Returns:

the width for pixel values in Y.

setPixelXWidth

public void setPixelXWidth(double pixelXWidth)

Sets the width for pixel values in X in this request.

Parameters:

pixelXWidth - the width for pixel values in X in this request.

setPixelYWidth

public void setPixelYWidth(double pixelYWidth)

Sets the width for pixel values in Y in this request.

Parameters:

pixelYWidth - the width for pixel values in Y in this request.

setDirectory

public void setDirectory(java.lang.String directory)

Sets the directory where the mosaic's ouput will be stored, it can be in NFS for regular FileSystem or in HDFS for Hadoop storage, depending on the setting for mosaics FileSystem.

Parameters:

directory - the String specifying Filesystem for the mosaic's output FS or HDFS.

getDirectory

public java.lang.String getDirectory()

Gets the output Filesystem for this request.

Returns:

FS for regular Filesystem or HDFS for Hadoop storage.

setTemporaryFolder

public void setTemporaryFolder(java.lang.String temporaryFolder)

Sets the temporary folder used when HDFS output is requested to store partial FS output before calling image loader job.

Parameters:

temporaryFolder - the temporary output folder for HDFS output

getTemporaryFolder

public java.lang.String getTemporaryFolder()

Gets the temporary output folder where partial output is stored when HDFS output is requested

Returns:

the temporary output folder for HDFS output

setDeleteLocalFile

public void setDeleteLocalFile(boolean deleteLocalFile)

Sets the flag that indicates if the temporary output file will be deleted or not after is loaded in HDFS

Parameters:

deleteLocalFile - defaults to true, indicates if local output file will be deleted or not

isDeleteLocalFile

public boolean isDeleteLocalFile()

Gets the flag that indicates if the temporary output file will be deleted or not after is loaded in HDFS

Returns:

the flag that indicates if local output file will be deleted or not, defaults to true

setBands

public void setBands(int bands)

Sets the number of bands for this mosaic request

Parameters:

bands - number of bands requested for this mosaic operation

setLayers

public void setLayers(java.lang.String layers)

Sets the order of appearance of bands in output, if the list contains more bands that the ones configured for output, the rest are ignored.

Parameters:

layers - bands order of appearance

getLayers

public java.lang.String getLayers()

Get the order of appearance of bands in output

Returns:

layers bands order of appearance

setProcessingClasses

public void setProcessingClasses(java.lang.String processingClasses)

Sets the processing classes for the related input. Container jar file must be added to job configuration using RasterProcessorJob setUserProcessingJar method.

Parameters:

processingClasses - the String detailing the processing classes for the related input. Processing classes are executed before the mosaic operation. Comma separated list.

setReduceProcessingClasses

public void setReduceProcessingClasses(java.lang.String reduceProcessingClasses)

Sets the reducer processing classes for the related input. Container jar file must be added to job configuration using RasterProcessorJob setUserProcessingJar method.

Parameters:

reduceProcessingClasses - the String detailing the reducer processing classes for the related input. Reducer processing classes are executed before the mosaic operation. Comma separated list.

getReduceProcessingClasses

public java.lang.String getReduceProcessingClasses()

Gets the reducer processing classes for the related input.

Returns:

the String detailing the reducer processing classes for the related input.

addProcessingClass

public void addProcessingClass(java.lang.String processingClass)

Adds a processing class to this mosaic request

Parameters:

processingClass - class to add in this mosaic request, this class will be executed in the processing framework.

addReduceProcessingClass

public void addReduceProcessingClass(java.lang.String reduceProcessingClass)

Adds a reduce processing class to this mosaic request

Parameters:

reduceProcessingClass - class to add in this mosaic request, this class will be executed in the processing framework during reduce phase.

getProcessingClasses

public java.lang.String getProcessingClasses()

Gets the processing classes for the related input.

Returns:

the processing classes for this request.

setFileSystem

public void setFileSystem(java.lang.String fileSystem)

Sets the Filesystem where mosaic will be stored

Parameters:

fileSystem - can be RasterProcessorjob.HDFS or RasterProcessorJob.FS depending on where the mosaic output is expected to be stored.

getFileSystem

public java.lang.String getFileSystem()

Gets the Filesystem where mosaic will be stored. Can be RasterProcessorjob.HDFS or RasterProcessorJob.FS

Returns:

fileSystem can be HDFS or FS depending on where the mosaic output is expected to be stored.

setFileName

public void setFileName(java.lang.String fileName)

Sets the file name fot tue ouput mosaic

Parameters:

fileName - the name of the output mosaic file

getFileName

public java.lang.String getFileName()

Gets the file name fot tue ouput mosaic

Returns:

fileName the name of the output mosaic file

setOrderAlgorithm

public void setOrderAlgorithm(java.lang.String orderAlgorithm)

Sets the ordering algorithm for the images in this request. ProcessConstants.ALGORITHM_FILE_LENGTH, ProcessConstants.ALGORITHM_MODIFIED_DATE or ProcessConstants.ALGORITHM_RESOLUTION

Parameters:

orderAlgorithm - Ordering algorithm to be considered in this mosaic request.

getOrderAlgorithm

public java.lang.String getOrderAlgorithm()

Gets the the ordering algorithm for the images in this request. ProcessConstants.ALGORITHM_FILE_LENGTH, ProcessConstants.ALGORITHM_MODIFIED_DATE or ProcessConstants.ALGORITHM_RESOLUTION

Returns:

the ordering algorithm to be considered in this mosaic request.

getCompactMosaic

public java.lang.String getCompactMosaic()

Gets a String representing this mosaic request configuration, used to set it to Job configuration.

Returns:

String with mosaic´s request data. The String has the following structure: SRID|temporaryoutputfolder|outputdirectory|filename|format|width|height|nodatavalue|order pixelType|pixelXWidth|pixelYWidth|upperLeftX|upperLeftY|bands|orderAlgorithm|processingClasses.