Package com.couchbase.lite

Class Join

java.lang.Object

com.couchbase.lite.Join

Direct Known Subclasses:

Join.On

public class Join
extends Object

A Join component representing a single JOIN clause in the query statement.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Join.On	Component used for specifying join on conditions.

Method Summary

Modifier and Type	Method	Description
static Join	crossJoin(DataSource datasource)	Create an CROSS JOIN component with the given data source.
static Join.On	innerJoin(DataSource datasource)	Create an INNER JOIN component with the given data source.
static Join.On	join(DataSource datasource)	Create a JOIN (same as INNER JOIN) component with the given data source.
static Join.On	leftJoin(DataSource datasource)	Create a LEFT JOIN (same as LEFT OUTER JOIN) component with the given data source.
static Join.On	leftOuterJoin(DataSource datasource)	Create a LEFT OUTER JOIN component with the given data source.

Methods inherited from class java.lang.Object

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

Method Details

join

@NonNull
public static Join.On join(@NonNull
 DataSource datasource)

Create a JOIN (same as INNER JOIN) component with the given data source. Use the returned On component to specify join conditions.

Parameters:

datasource - The DataSource object of the JOIN clause.

Returns:

The On object used for specifying join conditions.

innerJoin

@NonNull
public static Join.On innerJoin(@NonNull
 DataSource datasource)

Create an INNER JOIN component with the given data source. Use the returned On component to specify join conditions.

Parameters:

datasource - The DataSource object of the JOIN clause.

Returns:

The On object used for specifying join conditions.

leftJoin

@NonNull
public static Join.On leftJoin(@NonNull
 DataSource datasource)

Create a LEFT JOIN (same as LEFT OUTER JOIN) component with the given data source. Use the returned On component to specify join conditions.

Parameters:

datasource - The DataSource object of the JOIN clause.

Returns:

The On object used for specifying join conditions.

leftOuterJoin

@NonNull
public static Join.On leftOuterJoin(@NonNull
 DataSource datasource)

Create a LEFT OUTER JOIN component with the given data source. Use the returned On component to specify join conditions.

Parameters:

datasource - The DataSource object of the JOIN clause.

Returns:

The On object used for specifying join conditions.

crossJoin

@NonNull
public static Join crossJoin(@NonNull
 DataSource datasource)

Create an CROSS JOIN component with the given data source. Use the returned On component to specify join conditions.

Parameters:

datasource - The DataSource object of the JOIN clause.

Returns:

The Join object used for specifying join conditions.