org.esa.beam.framework.gpf.internal
Class OperatorContext

java.lang.Object
  org.esa.beam.framework.gpf.internal.OperatorContext

public class OperatorContext
extends Object

The context in which operators are executed.

Since:

4.1

Author:

Norman Fomferra

Constructor Summary

OperatorContext(Operator operator)

Method Summary

void	addRenderingHints(RenderingHints renderingHints)
void	checkForCancellation()
void	dispose()
void	fireTileComputed(OperatorImage operatorImage, Rectangle destRect, long startNanos)
String	getId()
Logger	getLogger()
Operator	getOperator()
OperatorSpi	getOperatorSpi()
Object	getParameter(String name)
Map<String,Object>	getParameters()
RenderingHints	getRenderingHints()
Product	getSourceProduct(String id)
String	getSourceProductId(Product product)
Product[]	getSourceProducts()
Tile	getSourceTile(RasterDataNode rasterDataNode, Rectangle region)
Tile	getSourceTile(RasterDataNode rasterDataNode, Rectangle region, javax.media.jai.BorderExtender borderExtender)
OperatorImage	getTargetImage(Band band)
Product	getTargetProduct()
Object	getTargetProperty(String name)
void	injectConfiguration()
void	injectParameterDefaultValues()
boolean	isCancelled()
boolean	isComputeTileMethodUsable()
boolean	isComputeTileStackMethodUsable()
boolean	isDisposed()
boolean	isInitialized()
static boolean	isRegularBand(Band targetBand)
boolean	requiresAllBands()
void	setCancelled(boolean cancelled)
void	setComputeTileMethodUsable(boolean computeTileMethodUsable)
void	setComputeTileStackMethodUsable(boolean computeTileStackMethodUsable)
void	setConfiguration(OperatorConfiguration opConfiguration)
void	setId(String id)
void	setLogger(Logger logger)
void	setOperatorSpi(OperatorSpi operatorSpi)
void	setParameter(String name, Object value)
void	setParameters(Map<String,Object> parameters)
void	setRequiresAllBands(boolean requiresAllBands)
void	setSourceProduct(String id, Product product)
void	setSourceProducts(Map<String,Product> sourceProducts)
void	setSourceProducts(Product[] products)
void	setTargetProduct(Product targetProduct)
static void	setTileCache(javax.media.jai.OpImage image) Makes sure that the given JAI OpImage has a valid tile cache (see System property GPF.USE_FILE_TILE_CACHE_PROPERTY), or makes sure that it has none (see System property GPF.DISABLE_TILE_CACHE_PROPERTY).
void	stopTileComputationObservation()
void	updateOperator() Updates this operator forcing it to recreate the target product.

Methods inherited from class java.lang.Object

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

Constructor Detail

OperatorContext

public OperatorContext(Operator operator)

Method Detail

setTileCache

public static void setTileCache(javax.media.jai.OpImage image)

Makes sure that the given JAI OpImage has a valid tile cache (see System property GPF.USE_FILE_TILE_CACHE_PROPERTY), or makes sure that it has none (see System property GPF.DISABLE_TILE_CACHE_PROPERTY).

Parameters:

image - Any JAI OpImage.

getId

public String getId()

setId

public void setId(String id)

getLogger

public Logger getLogger()

setLogger

public void setLogger(Logger logger)

getSourceProduct

public Product getSourceProduct(String id)

setSourceProduct

public void setSourceProduct(String id,
                             Product product)

getSourceProducts

public Product[] getSourceProducts()

setSourceProducts

public void setSourceProducts(Product[] products)

setSourceProducts

public void setSourceProducts(Map<String,Product> sourceProducts)

getSourceProductId

public String getSourceProductId(Product product)

getTargetProduct

public Product getTargetProduct()
                         throws OperatorException

Throws:

OperatorException

setTargetProduct

public void setTargetProduct(Product targetProduct)

getTargetProperty

public Object getTargetProperty(String name)

isCancelled

public boolean isCancelled()

setCancelled

public void setCancelled(boolean cancelled)

checkForCancellation

public void checkForCancellation()
                          throws OperatorException

Throws:

OperatorException

getOperatorSpi

public OperatorSpi getOperatorSpi()

setOperatorSpi

public void setOperatorSpi(OperatorSpi operatorSpi)

getOperator

public Operator getOperator()

getParameter

public Object getParameter(String name)

setParameter

public void setParameter(String name,
                         Object value)

getParameters

public Map<String,Object> getParameters()

setParameters

public void setParameters(Map<String,Object> parameters)

getRenderingHints

public RenderingHints getRenderingHints()

addRenderingHints

public void addRenderingHints(RenderingHints renderingHints)

setConfiguration

public void setConfiguration(OperatorConfiguration opConfiguration)

isInitialized

public boolean isInitialized()

isComputeTileMethodUsable

public boolean isComputeTileMethodUsable()

isComputeTileStackMethodUsable

public boolean isComputeTileStackMethodUsable()

setComputeTileMethodUsable

public void setComputeTileMethodUsable(boolean computeTileMethodUsable)

setComputeTileStackMethodUsable

public void setComputeTileStackMethodUsable(boolean computeTileStackMethodUsable)

getSourceTile

public Tile getSourceTile(RasterDataNode rasterDataNode,
                          Rectangle region)

getSourceTile

public Tile getSourceTile(RasterDataNode rasterDataNode,
                          Rectangle region,
                          javax.media.jai.BorderExtender borderExtender)

getTargetImage

public OperatorImage getTargetImage(Band band)

isDisposed

public boolean isDisposed()

dispose

public void dispose()

updateOperator

public void updateOperator()
                    throws OperatorException

Updates this operator forcing it to recreate the target product. Warning: Experimental API added by nf (25.02.2010)

Throws:

OperatorException - If an error occurs.

Since:

BEAM 4.8

isRegularBand

public static boolean isRegularBand(Band targetBand)

injectConfiguration

public void injectConfiguration()
                         throws OperatorException

Throws:

OperatorException

injectParameterDefaultValues

public void injectParameterDefaultValues()
                                  throws OperatorException

Throws:

OperatorException

stopTileComputationObservation

public void stopTileComputationObservation()

fireTileComputed

public void fireTileComputed(OperatorImage operatorImage,
                             Rectangle destRect,
                             long startNanos)

requiresAllBands

public boolean requiresAllBands()

setRequiresAllBands

public void setRequiresAllBands(boolean requiresAllBands)