oracle.spatial.hadoop.rasterapi.core.jobs

Class RasterLoaderJob

java.lang.Object

oracle.spatial.hadoop.rasterapi.core.jobs.RasterJob

oracle.spatial.hadoop.rasterapi.core.jobs.RasterLoaderJob

public class RasterLoaderJob
extends RasterJob

Represents a Hadoop job that executes the loading of rasters into HDFS using the received configuration.

Field Summary

Fields inherited from class oracle.spatial.hadoop.rasterapi.core.jobs.RasterJob

job, log

Constructor Summary

Constructors

Constructor and Description
RasterLoaderJob(org.apache.hadoop.conf.Configuration config) Raster Loader Job constructor using an existing configuration

Method Summary

Modifier and Type	Method and Description
void	addFileToLoad(java.lang.String fileToLoad) Adds a file to the list of rasters to load by this job
void	dontExpandOutputDir() Output results will be put in directory without expanding source path
boolean	execute() Executes the configured raster loader job.
void	setFilesToLoad(java.lang.String filesToLoad) Sets the files to load in this job.
void	setGdalPath(java.lang.String gdalLibPath) Sets GDAL library path to this job
void	setOutputFolder(java.lang.String outputFolder) Sets the hdfs output folder for the loaded rasters of this job.
void	setRasterThumbnailFolder(java.lang.String thumbnailFolder) Sets the folder to store thumbnails of the rasters loaded by this job.
void	setTileOverlap(java.lang.String tileOverlap) Sets the overlapping bytes per tile border for this job load

Methods inherited from class oracle.spatial.hadoop.rasterapi.core.jobs.RasterJob

execute, getHadoopJob

Methods inherited from class java.lang.Object

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

Constructor Detail

RasterLoaderJob

public RasterLoaderJob(org.apache.hadoop.conf.Configuration config)

Raster Loader Job constructor using an existing configuration

Parameters:

config - job configuration with previously loaded properties.

Method Detail

setFilesToLoad

public void setFilesToLoad(java.lang.String filesToLoad)

Sets the files to load in this job.

Parameters:

filesToLoad - it can be a single file or folder, or a comma separated list of multple inputs.

addFileToLoad

public void addFileToLoad(java.lang.String fileToLoad)

Adds a file to the list of rasters to load by this job

Parameters:

fileToLoad - location of the raster to load

setTileOverlap

public void setTileOverlap(java.lang.String tileOverlap)

Sets the overlapping bytes per tile border for this job load

Parameters:

tileOverlap - number of overlapping bytes in every raster tile´s border. If none is specified, a default value of 2 is used.

dontExpandOutputDir

public void dontExpandOutputDir()

Output results will be put in directory without expanding source path

setOutputFolder

public void setOutputFolder(java.lang.String outputFolder)

Sets the hdfs output folder for the loaded rasters of this job. This value is a must have for job to execute correctly

Parameters:

outputFolder - hdfs output folder where .ohif files will be created

setRasterThumbnailFolder

public void setRasterThumbnailFolder(java.lang.String thumbnailFolder)

Sets the folder to store thumbnails of the rasters loaded by this job. This is an optional setting for loader job

Parameters:

thumbnailFolder - the NFS output folder where thumbnails of the loaded rasters can be stored, this folder must be shared across NFS through all nodes and must have write access for every user involved in job execution.

execute

public boolean execute()
                throws java.lang.Exception

Executes the configured raster loader job. It also validates that all required input configuration has been set correctly.

Returns:

true if the job is executed successfully or false otherwise.

Throws:

java.lang.Exception - whenever there is a problem during raster load job execution

setGdalPath

public void setGdalPath(java.lang.String gdalLibPath)
                 throws java.lang.Exception

Sets GDAL library path to this job

Parameters:

gdalLibPath - path to gdal native libraries path

Throws:

java.lang.Exception - whenever there is a problem during GDAL libraries load into job classpath.