Module litebridge.orm

Package org.litebridge.orm.api.dto

Class DtoJoinSpec

java.lang.Object

org.litebridge.orm.api.select.impl.AbstractConditionBasedSpec

org.litebridge.orm.api.select.impl.AbstractJoinSpec

org.litebridge.orm.api.dto.DtoJoinSpec

All Implemented Interfaces:

DtoDataSpec, JoinSpec

public final class DtoJoinSpec
extends org.litebridge.orm.api.select.impl.AbstractJoinSpec
implements DtoDataSpec

Specification for a JOIN clause in a DTO-based query.

Field Summary

Fields inherited from class org.litebridge.orm.api.select.impl.AbstractConditionBasedSpec

conditions, table

Constructor Summary

Constructors

Constructor	Description
DtoJoinSpec(Class<?> dtoClass, OrmTable ormTable, Table table, SelectExpressionMapper selectExpressionMapper)	Creates a new instance of DtoJoinSpec.

Method Summary

Modifier and Type	Method	Description
@Nullable FieldAccessor	collectionField()	Returns the collection field for this join.
Class<?>	dtoClass()	Returns the DTO class being joined.
OrmTable	dtoTable()	Returns the ORM table metadata for the DTO.
List<DtoSelectSpec.FieldColumn>	getFieldColumns()	Returns the list of field columns for this join.
@Nullable FieldAccessor	reverseCollectionField()	Returns the reverse collection field for this join.
void	setCollectionField(@Nullable FieldAccessor collectionField)	Sets the collection field for this join.
void	setFieldColumns(@Nullable List<DtoSelectSpec.FieldColumn> fieldColumns)	Sets the list of field columns for this join.
void	setReverseCollectionField(@Nullable FieldAccessor reverseCollectionField)	Sets the reverse collection field for this join.
void	setSourceDtoClass(@Nullable Class<?> sourceDtoClass)	Sets the source DTO class for this join.
@Nullable Class<?>	sourceDtoClass()	Returns the source DTO class for this join.

Methods inherited from class org.litebridge.orm.api.select.impl.AbstractJoinSpec

toJoin, using

Methods inherited from class org.litebridge.orm.api.select.impl.AbstractConditionBasedSpec

currentConditionGroupSpec, popConditionGroupSpec, pushConditionGroupSpec, table

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.litebridge.orm.api.select.model.JoinSpec

currentConditionGroupSpec, popConditionGroupSpec, pushConditionGroupSpec, table

Constructor Details

DtoJoinSpec

public DtoJoinSpec(Class<?> dtoClass,
 OrmTable ormTable,
 Table table,
 SelectExpressionMapper selectExpressionMapper)

Creates a new instance of DtoJoinSpec.

Parameters:

dtoClass - the class of the DTO being joined

ormTable - the metadata of the table being joined

table - the database table representation

selectExpressionMapper - the mapper for select expressions

Method Details

dtoClass

public Class<?> dtoClass()

Returns the DTO class being joined.

Returns:

the DTO class

dtoTable

public OrmTable dtoTable()

Description copied from interface: DtoDataSpec

Returns the ORM table metadata for the DTO.

Specified by:

dtoTable in interface DtoDataSpec

Returns:

the ORM table metadata

sourceDtoClass

public @Nullable Class<?> sourceDtoClass()

Returns the source DTO class for this join.

Returns:

the source DTO class

setSourceDtoClass

public void setSourceDtoClass(@Nullable Class<?> sourceDtoClass)

Sets the source DTO class for this join.

Parameters:

sourceDtoClass - the source DTO class

getFieldColumns

public List<DtoSelectSpec.FieldColumn> getFieldColumns()

Returns the list of field columns for this join.

Returns:

the list of field columns

setFieldColumns

public void setFieldColumns(@Nullable List<DtoSelectSpec.FieldColumn> fieldColumns)

Sets the list of field columns for this join.

Parameters:

fieldColumns - the list of field columns

collectionField

public @Nullable FieldAccessor collectionField()

Returns the collection field for this join.

Returns:

the collection field, or null if not a collection join

setCollectionField

public void setCollectionField(@Nullable FieldAccessor collectionField)

Sets the collection field for this join.

Parameters:

collectionField - the collection field

reverseCollectionField

public @Nullable FieldAccessor reverseCollectionField()

Returns the reverse collection field for this join.

Returns:

the reverse collection field, or null if none

setReverseCollectionField

public void setReverseCollectionField(@Nullable FieldAccessor reverseCollectionField)

Sets the reverse collection field for this join.

Parameters:

reverseCollectionField - the reverse collection field