public class

JoinTableDataSource

extends DataSource
java.lang.Object
   ↳ com.esri.core.map.DataSource
     ↳ com.esri.core.map.JoinTableDataSource

Class Overview

The Class JoinTableDataSource is the result of a join operation. Nested joins are supported. To use nested joins set either of leftTableSource or rightTableSource to be a JoinTableDataSource.

Note:

  • The layer type is determined by the leftTableSource. If the leftTableSource is a table then the resulting JoinTableDataSource is a table. If the leftTableSource is a layer then the resulting JoinTableDataSource is a layer.
  • For performance reasons it is ideal to have leftTableSource and rightTableSource to point to data source from the same workspace and leftTableKey/rightTableKey indexed.

  • Summary

    Nested Classes
    enum JoinTableDataSource.JoinType The Enum JoinType. 
    Public Constructors
    JoinTableDataSource()
    Instantiates a new join table data source.
    Public Methods
    JoinTableDataSource.JoinType getJoinType()
    Gets the join type.
    String getLeftTableKey()
    Gets the left table key.
    LayerSource getLeftTableSource()
    Gets the left table source.
    String getRightTableKey()
    Gets the right table key.
    LayerSource getRightTableSource()
    Gets the right table source.
    void setJoinType(JoinTableDataSource.JoinType joinType)
    Sets the join type.
    void setLeftTableKey(String leftTableKey)
    Sets the left table key.
    void setLeftTableSource(LayerSource leftTableSource)
    Sets the left table source.
    void setRightTableKey(String rightTableKey)
    Sets the right table key.
    void setRightTableSource(LayerSource rightTableSource)
    Sets the right table source.
    String toJson()
    String toString()
    [Expand]
    Inherited Methods
    From class com.esri.core.map.DataSource
    From class java.lang.Object

    Public Constructors

    public JoinTableDataSource ()

    Instantiates a new join table data source.

    Public Methods

    public JoinTableDataSource.JoinType getJoinType ()

    Gets the join type.

    Returns
    JoinTableDataSource.JoinType the join type

    public String getLeftTableKey ()

    Gets the left table key.

    Returns
    String the left table key

    public LayerSource getLeftTableSource ()

    Gets the left table source.

    Returns
    LayerSource the left table source

    public String getRightTableKey ()

    Gets the right table key.

    Returns
    String the right table key

    public LayerSource getRightTableSource ()

    Gets the right table source.

    Returns
    LayerSource the right table source

    public void setJoinType (JoinTableDataSource.JoinType joinType)

    Sets the join type.

    Parameters
    joinType JoinTableDataSource.JoinType: the new join type

    public void setLeftTableKey (String leftTableKey)

    Sets the left table key.

    Parameters
    leftTableKey String: the new left table key

    public void setLeftTableSource (LayerSource leftTableSource)

    Sets the left table source.

    Parameters
    leftTableSource LayerSource: the new left table source

    public void setRightTableKey (String rightTableKey)

    Sets the right table key.

    Parameters
    rightTableKey String: the new right table key

    public void setRightTableSource (LayerSource rightTableSource)

    Sets the right table source.

    Parameters
    rightTableSource LayerSource: the new right table source

    public String toJson ()

    Returns
    String
    Throws
    Exception

    public String toString ()

    Returns
    String