Package com.activeviam.directquery.api.schema

Class JoinDescription

java.lang.Object

com.activeviam.directquery.api.schema.JoinDescription

All Implemented Interfaces:

ITableJoin

public final class JoinDescription
extends Object
implements ITableJoin

Immutable description of a join between two tables.

Default RelationshipOptionality is RelationshipOptionality.OPTIONAL.

Author:

ActiveViam

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JoinDescription.JoinDescriptionBuilder

Nested classes/interfaces inherited from interface com.activeviam.database.api.schema.ITableJoin

ITableJoin.FieldMapping

Method Summary

Modifier and Type	Method	Description
static JoinDescription.JoinDescriptionBuilder	builder()
boolean	equals(Object o)
Set<ITableJoin.FieldMapping>	getFieldMappings()	Returns the mappings between the fields of the source table to the fields of the target table.
String	getName()	Returns the name of the join.
String	getSourceTableName()	Returns the name of the source table of the join.
RelationshipOptionality	getTargetOptionality()
String	getTargetTableName()	Returns the name of the target table of the join.
int	hashCode()
JoinDescription.JoinDescriptionBuilder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

toString

public String toString()

Overrides:

toString in class Object

builder

public static JoinDescription.JoinDescriptionBuilder builder()

toBuilder

public JoinDescription.JoinDescriptionBuilder toBuilder()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getSourceTableName

public String getSourceTableName()

Description copied from interface: ITableJoin

Returns the name of the source table of the join.

Specified by:

getSourceTableName in interface ITableJoin

getTargetTableName

public String getTargetTableName()

Description copied from interface: ITableJoin

Returns the name of the target table of the join.

Specified by:

getTargetTableName in interface ITableJoin

getName

public String getName()

Description copied from interface: ITableJoin

Returns the name of the join.

Specified by:

getName in interface ITableJoin

getFieldMappings

public Set<ITableJoin.FieldMapping> getFieldMappings()

Description copied from interface: ITableJoin

Returns the mappings between the fields of the source table to the fields of the target table.

Specified by:

getFieldMappings in interface ITableJoin

getTargetOptionality

public RelationshipOptionality getTargetOptionality()