edu.ucdavis.cstars.client.layers

Class JoinDataSource

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.layers.JoinDataSource

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

Class added v2.7 The JoinDataSource class defines and provides information about the result of a join operation. Nested joins are supported and are created by specifying either the leftTableSource or rightTableSource to be the joined table. The output type is determined by the leftTableSource. If the leftTableSource is a table then the resulting join table is a table. If the leftTableSource is a layer then the join result will be a layer. For the best performance, the left and right table sources should point to the same workspace and the table keys should be indexed.

Author:

Justin Merz

Method Summary

Methods

Modifier and Type	Method and Description
static JoinDataSource	create() Creates a new JoinDataSource object.
static JoinDataSource	create(com.google.gwt.core.client.JavaScriptObject jso) Creates a new JoinDataSource object.
java.lang.String	getJoinType() The type of join that will be performed.
java.lang.String	getLeftTableKey() The key field used for the left table source for the join.
LayerDataSource	getLeftTableSourceAsLayerDataSource() The data source to be used as the left table for the join operation.
LayerMapSource	getLeftTableSourceAsLayerMapSource() The data source to be used as the left table for the join operation.
java.lang.String	getRightTableKey() The key field used for the right table source for the join.
LayerDataSource	getRightTableSourceAsLayerDataSource() The data source to be used as the right table for the join operation.
LayerMapSource	getRightTableSourceAsLayerMapSource() The data source to be used as the right table for the join operation.
void	setJoinType(java.lang.String joinType) Set the join type parameter.
void	setLeftTableKey(java.lang.String leftTableKey) Set the left table key.
void	setLeftTableSource(LayerDataSource leftTableSource) Set the left table source.
void	setLeftTableSource(LayerMapSource leftTableSource) Set the left table source.
void	setRightTableKey(java.lang.String rightTableKey) Set the right table key.
void	setRightTableSource(LayerDataSource rightTableSource) Set the right table data source.
void	setRightTableSource(LayerMapSource rightTableSource) Set the right table data source.
com.google.gwt.core.client.JavaScriptObject	toJson() Converts object to its ArcGIS Server JSON representation.

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 JoinDataSource create()

Creates a new JoinDataSource object.

Returns:

JoinDataSource

create

public static JoinDataSource create(com.google.gwt.core.client.JavaScriptObject jso)

Creates a new JoinDataSource object.

Parameters:

jso - - JSON object representing the JoinDataSource.

Returns:

JoinDataSource

getJoinType

public final java.lang.String getJoinType()

The type of join that will be performed. Known values: left-outer | left-inner TODO: return enum

Returns:

String

setJoinType

public final void setJoinType(java.lang.String joinType)

Set the join type parameter.

Parameters:

joinType - - The type of join that will be performed.

getLeftTableKey

public final java.lang.String getLeftTableKey()

The key field used for the left table source for the join.

Returns:

String

setLeftTableKey

public final void setLeftTableKey(java.lang.String leftTableKey)

Set the left table key.

Parameters:

leftTableKey - - The key field used for the left table source for the join.

getLeftTableSourceAsLayerMapSource

public final LayerMapSource getLeftTableSourceAsLayerMapSource()

The data source to be used as the left table for the join operation. Determines the output join table type. If the leftTableSource is a table then the output is a table. If the leftDataSource is a layer then the resulting join table is a layer.

Returns:

LayerMapSource

getLeftTableSourceAsLayerDataSource

public final LayerDataSource getLeftTableSourceAsLayerDataSource()

The data source to be used as the left table for the join operation. Determines the output join table type. If the leftTableSource is a table then the output is a table. If the leftDataSource is a layer then the resulting join table is a layer.

Returns:

LayerDataSource

setLeftTableSource

public final void setLeftTableSource(LayerMapSource leftTableSource)

Set the left table source.

Parameters:

leftTableSource - - The data source to be used as the left table for the join operation. Determines the output join table type. If the leftTableSource is a table then the output is a table. If the leftDataSource is a layer then the resulting join table is a layer.

setLeftTableSource

public final void setLeftTableSource(LayerDataSource leftTableSource)

Set the left table source.

Parameters:

leftTableSource - - The data source to be used as the left table for the join operation. Determines the output join table type. If the leftTableSource is a table then the output is a table. If the leftDataSource is a layer then the resulting join table is a layer.

getRightTableKey

public final java.lang.String getRightTableKey()

The key field used for the right table source for the join.

Returns:

String

setRightTableKey

public final void setRightTableKey(java.lang.String rightTableKey)

Set the right table key.

Parameters:

rightTableKey - - The key field used for the right table source for the join.

getRightTableSourceAsLayerMapSource

public final LayerMapSource getRightTableSourceAsLayerMapSource()

The data source to be used as the right table for the join operation.

Returns:

LayerMapSource

getRightTableSourceAsLayerDataSource

public final LayerDataSource getRightTableSourceAsLayerDataSource()

The data source to be used as the right table for the join operation.

Returns:

LayerDataSource

setRightTableSource

public final void setRightTableSource(LayerMapSource rightTableSource)

Set the right table data source.

Parameters:

rightTableSource - - The data source to be used as the right table for the join operation.

setRightTableSource

public final void setRightTableSource(LayerDataSource rightTableSource)

Set the right table data source.

Parameters:

rightTableSource - - The data source to be used as the right table for the join operation.

toJson

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

Converts object to its ArcGIS Server JSON representation.

Returns:

JavaScriptObject