edu.ucdavis.cstars.client.layers

Class MosaicRule

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.layers.MosaicRule

public class MosaicRule
extends com.google.gwt.core.client.JavaScriptObject

Specifies the mosaic rule when defining how individual images should be mosaicked. It specifies selection, mosaic method, sort order, overlapping pixel resolution, etc. Mosaic rules are for mosaicking rasters in the mosaic dataset. A mosaic rule is used to define: -The selection of rasters that will participate in the mosaic (using where clause). -The mosaic method, e.g. how the selected rasters are ordered. -The mosaic operation, e.g. how overlapping pixels at the same location are resolved.

Author:

Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MosaicRule.Methods
static class	MosaicRule.Operations

Method Summary

Methods

Modifier and Type	Method and Description
void	addLockRasterId(int id) Add raster id to participate in the mosaic
void	clearLockRasterIds() clear the list of locked raster ids.
static MosaicRule	create() Creates a new MosaicRule object
com.google.gwt.core.client.JsArrayInteger	getLockRasterIds() An array of raster Ids.
MosaicRule.Methods	getMethod() The mosaic method determines how the selected rasters are ordered.
com.google.gwt.core.client.JsArrayInteger	getObjectIds() Defines a selection using a set of ObjectIds.
MosaicRule.Operations	getOperation() Defines the mosaic operation used to resolve overlapping pixels.
java.lang.String	getSortField() The name of the attribute field that is used together with a constant sortValue to define the mosaicking order when the mosaic method is set to METHOD_ATTRIBUTE.
java.lang.String	getSortValue() A constant value defining a reference or base value for the sort field when the mosaic method is set to METHOD_ATTRIBUTE.
Point	getViewPoint() Defines the viewpoint location on which the ordering is defined based on the distance from the viewpoint and the nadir of rasters.
java.lang.String	getWhere() The where clause determines which rasters will participate in the mosaic.
boolean	isAscending() Indicates whether the sort should be ascending or not.
void	setAscending(boolean ascending) Set sort type
void	setMethod(MosaicRule.Methods method) Set mosaic method
void	setObjectIds(int[] objectIds) Set the objectIds parameter.
void	setOperation(MosaicRule.Operations operation) Set the operation.
void	setSortField(java.lang.String sortField) Set the sortField value.
void	setSortValue(java.lang.String sortValue) Set the sortValue.
void	setViewPoint(Point viewPoint) Set the viewPoint value.
void	setWhere(java.lang.String where) Set the where value.
com.google.gwt.core.client.JavaScriptObject	toJson() Returns an easily serializable object representation of the mosaic rule.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static MosaicRule create()

Creates a new MosaicRule object

Returns:

MosaicRule

isAscending

public final boolean isAscending()

Indicates whether the sort should be ascending or not.

Returns:

boolean

setAscending

public final void setAscending(boolean ascending)

Set sort type

Parameters:

ascending - - Indicates whether the sort should be ascending or not.

getLockRasterIds

public final com.google.gwt.core.client.JsArrayInteger getLockRasterIds()

An array of raster Ids. All the rasters with the given list of raster Ids are selected to participate in the mosaic. The rasters will be visible at all pixel sizes regardless of the minimum and maximum pixel size range of the locked rasters.

Returns:

JsArrayInteger

addLockRasterId

public final void addLockRasterId(int id)

Add raster id to participate in the mosaic

Parameters:

id - - id of raster

clearLockRasterIds

public final void clearLockRasterIds()

clear the list of locked raster ids.

getMethod

public final MosaicRule.Methods getMethod()

The mosaic method determines how the selected rasters are ordered.

Returns:

Methods

setMethod

public final void setMethod(MosaicRule.Methods method)

Set mosaic method

Parameters:

method - - The mosaic method determines how the selected rasters are ordered.

getObjectIds

public final com.google.gwt.core.client.JsArrayInteger getObjectIds()

Defines a selection using a set of ObjectIds. This property applies to all mosaic methods.

Returns:

JsArrayInteger

setObjectIds

public final void setObjectIds(int[] objectIds)

Set the objectIds parameter.

Parameters:

objectIds - - Defines a selection using a set of ObjectIds. This property applies to all mosaic methods.

getOperation

public final MosaicRule.Operations getOperation()

Defines the mosaic operation used to resolve overlapping pixels.

Returns:

String

setOperation

public final void setOperation(MosaicRule.Operations operation)

Set the operation.

Parameters:

operation - - Defines the mosaic operation used to resolve overlapping pixels.

getSortField

public final java.lang.String getSortField()

The name of the attribute field that is used together with a constant sortValue to define the mosaicking order when the mosaic method is set to METHOD_ATTRIBUTE.

Returns:

String

setSortField

public final void setSortField(java.lang.String sortField)

Set the sortField value.

Parameters:

sortField - - The name of the attribute field that is used together with a constant sortValue to define the mosaicking order when the mosaic method is set to METHOD_ATTRIBUTE.

getSortValue

public final java.lang.String getSortValue()

A constant value defining a reference or base value for the sort field when the mosaic method is set to METHOD_ATTRIBUTE.

Returns:

String

setSortValue

public final void setSortValue(java.lang.String sortValue)

Set the sortValue.

Parameters:

sortValue - - A constant value defining a reference or base value for the sort field when the mosaic method is set to METHOD_ATTRIBUTE.

getViewPoint

public final Point getViewPoint()

Defines the viewpoint location on which the ordering is defined based on the distance from the viewpoint and the nadir of rasters.

Returns:

String

setViewPoint

public final void setViewPoint(Point viewPoint)

Set the viewPoint value.

Parameters:

viewPoint - - Defines the viewpoint location on which the ordering is defined based on the distance from the viewpoint and the nadir of rasters.

getWhere

public final java.lang.String getWhere()

The where clause determines which rasters will participate in the mosaic. This property applies to all mosaic methods.

Returns:

String

setWhere

public final void setWhere(java.lang.String where)

Set the where value.

Parameters:

where - - The where clause determines which rasters will participate in the mosaic. This property applies to all mosaic methods.

toJson

public final com.google.gwt.core.client.JavaScriptObject toJson()

Returns an easily serializable object representation of the mosaic rule. (As of v2.0)

Returns:

JavaScriptObject