Package com.esri.arcgisruntime.layers

Class TableJoinSublayerSource

java.lang.Object

com.esri.arcgisruntime.layers.SublayerSource

com.esri.arcgisruntime.layers.TableJoinSublayerSource

public final class TableJoinSublayerSource
extends SublayerSource

A table join sublayer source is the result of a join operation. Nested joins are supported. To use nested joins, set either leftTableSublayerSource or rightTableSublayerSource to be another TableJoinSublayerSource as its source.

Since:

100.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TableJoinSublayerSource.JoinType	The join type (left outer or left inner) of a table join sublayer source Can get the join type by calling getJoinType().

Constructor Summary

Constructors

Constructor	Description
TableJoinSublayerSource(java.lang.String leftTableKey, SublayerSource leftTableSublayerSource, java.lang.String rightTableKey, SublayerSource rightTableSublayerSource, TableJoinSublayerSource.JoinType joinType)	Creates a new table join sublayer source.

Method Summary

Modifier and Type	Method	Description
TableJoinSublayerSource.JoinType	getJoinType()	Gets the type of join.
java.lang.String	getLeftFieldName()	Gets the left table field name used in the join.
SublayerSource	getLeftTableSublayerSource()	Gets the left table sublayer source used in the join.
java.lang.String	getRightFieldName()	Gets the right table field name used in the join.
SublayerSource	getRightTableSublayerSource()	Gets the right table sublayer source used in the join.

Methods inherited from class java.lang.Object

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

Constructor Detail

TableJoinSublayerSource

public TableJoinSublayerSource(java.lang.String leftTableKey,
                               SublayerSource leftTableSublayerSource,
                               java.lang.String rightTableKey,
                               SublayerSource rightTableSublayerSource,
                               TableJoinSublayerSource.JoinType joinType)

Creates a new table join sublayer source.

Parameters:

leftTableKey - the left table key

leftTableSublayerSource - the left table source

rightTableKey - the right table key

rightTableSublayerSource - the right table source

joinType - the join type to use

Throws:

java.lang.IllegalArgumentException - if leftTableKey is null or empty

java.lang.IllegalArgumentException - if leftTableSource is null

java.lang.IllegalArgumentException - if rightTableKey is null or empty

java.lang.IllegalArgumentException - if rightTableSource is null

java.lang.IllegalArgumentException - if joinType is null

Since:

100.1.0

Method Detail

getLeftFieldName

public java.lang.String getLeftFieldName()

Gets the left table field name used in the join.

Returns:

the left table field

Since:

100.1.0

getRightFieldName

public java.lang.String getRightFieldName()

Gets the right table field name used in the join.

Returns:

the right table field

Since:

100.1.0

getLeftTableSublayerSource

public SublayerSource getLeftTableSublayerSource()

Gets the left table sublayer source used in the join.

Returns:

the left table sublayer source

Since:

100.1.0

getRightTableSublayerSource

public SublayerSource getRightTableSublayerSource()

Gets the right table sublayer source used in the join.

Returns:

the right table sublayer source

Since:

100.1.0

getJoinType

public TableJoinSublayerSource.JoinType getJoinType()

Gets the type of join.

Returns:

the join type

Since:

100.1.0