Class QJoinMetaData

java.lang.Object

com.kingsrook.qqq.backend.core.model.metadata.joins.QJoinMetaData

All Implemented Interfaces:

MetaDataProducerOutput, QMetaDataObject, TopLevelMetaDataInterface, Serializable, Cloneable

public class QJoinMetaData
extends Object
implements TopLevelMetaDataInterface, Cloneable

Definition of how 2 tables join together within a QQQ Instance.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
QJoinMetaData()

Method Summary

Modifier and Type	Method	Description
void	addSelfToInstance(QInstance qInstance)	call the appropriate methods on a QInstance to add ourselves to it.
QJoinMetaData	clone()
QJoinMetaData	flip()	Return a new QJoinMetaData, with all the same data as this one, but flipped right ←→ left, for the tables, the type, and the joinOns.
List<JoinOn>	getJoinOns()	Getter for joinOns
String	getLeftTable()	Getter for leftTable
String	getName()	Getter for name
List<QFilterOrderBy>	getOrderBys()	Getter for orderBys
String	getRightTable()	Getter for rightTable
JoinType	getType()	Getter for type
static String	makeInferredJoinName(String leftTable, String rightTable)
void	setJoinOns(List<JoinOn> joinOns)	Setter for joinOns
void	setLeftTable(String leftTable)	Setter for leftTable
void	setName(String name)	Setter for name
void	setOrderBys(List<QFilterOrderBy> orderBys)	Setter for orderBys
void	setRightTable(String rightTable)	Setter for rightTable
void	setType(JoinType type)	Setter for type
QJoinMetaData	withInferredName()
QJoinMetaData	withJoinOn(JoinOn joinOn)	Fluent setter for joinOns
QJoinMetaData	withJoinOns(List<JoinOn> joinOns)	Fluent setter for joinOns
QJoinMetaData	withLeftTable(String leftTable)	Fluent setter for leftTable
QJoinMetaData	withName(String name)	Fluent setter for name
QJoinMetaData	withOrderBy(QFilterOrderBy orderBy)	Fluent setter for orderBys
QJoinMetaData	withOrderBys(List<QFilterOrderBy> orderBys)	Fluent setter for orderBys
QJoinMetaData	withRightTable(String rightTable)	Fluent setter for rightTable
QJoinMetaData	withType(JoinType type)	Fluent setter for type

Methods inherited from class java.lang.Object

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

Constructor Details

QJoinMetaData

public QJoinMetaData()

Method Details

flip

public QJoinMetaData flip()

Return a new QJoinMetaData, with all the same data as this one, but flipped right ←→ left, for the tables, the type, and the joinOns.

clone

public QJoinMetaData clone()

Overrides:

clone in class Object

getName

public String getName()

Getter for name

Specified by:

getName in interface TopLevelMetaDataInterface

setName

public void setName(String name)

Setter for name

withName

public QJoinMetaData withName(String name)

Fluent setter for name

getType

public JoinType getType()

Getter for type

setType

public void setType(JoinType type)

Setter for type

withType

public QJoinMetaData withType(JoinType type)

Fluent setter for type

getLeftTable

public String getLeftTable()

Getter for leftTable

setLeftTable

public void setLeftTable(String leftTable)

Setter for leftTable

withLeftTable

public QJoinMetaData withLeftTable(String leftTable)

Fluent setter for leftTable

getRightTable

public String getRightTable()

Getter for rightTable

setRightTable

public void setRightTable(String rightTable)

Setter for rightTable

withRightTable

public QJoinMetaData withRightTable(String rightTable)

Fluent setter for rightTable

getJoinOns

public List<JoinOn> getJoinOns()

Getter for joinOns

setJoinOns

public void setJoinOns(List<JoinOn> joinOns)

Setter for joinOns

withJoinOns

public QJoinMetaData withJoinOns(List<JoinOn> joinOns)

Fluent setter for joinOns

withJoinOn

public QJoinMetaData withJoinOn(JoinOn joinOn)

Fluent setter for joinOns

getOrderBys

public List<QFilterOrderBy> getOrderBys()

Getter for orderBys

setOrderBys

public void setOrderBys(List<QFilterOrderBy> orderBys)

Setter for orderBys

withOrderBys

public QJoinMetaData withOrderBys(List<QFilterOrderBy> orderBys)

Fluent setter for orderBys

withOrderBy

public QJoinMetaData withOrderBy(QFilterOrderBy orderBy)

Fluent setter for orderBys

withInferredName

public QJoinMetaData withInferredName()

makeInferredJoinName

public static String makeInferredJoinName(String leftTable,
 String rightTable)

addSelfToInstance

public void addSelfToInstance(QInstance qInstance)

Description copied from interface: MetaDataProducerOutput

call the appropriate methods on a QInstance to add ourselves to it.

Specified by:

addSelfToInstance in interface MetaDataProducerOutput

Specified by:

addSelfToInstance in interface TopLevelMetaDataInterface