br.com.sankhya.jape.util

Class FinderWrapper

java.lang.Object

br.com.sankhya.jape.util.FinderWrapper

All Implemented Interfaces:

java.io.Serializable

public class FinderWrapper
extends java.lang.Object
implements java.io.Serializable

Encapsula informações sobre uma pesquisa na camada de dados.

Author:

Gualberto

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FinderWrapper.Pagination

Constructor Summary

Constructors

Constructor and Description
FinderWrapper(java.lang.String entity, java.lang.String where)
FinderWrapper(java.lang.String entity, java.lang.String where, java.lang.Object paramValue)
FinderWrapper(java.lang.String entity, java.lang.String where, java.lang.Object[] values)
FinderWrapper(java.lang.String entity, java.lang.String voAlias, java.lang.String where)
FinderWrapper(java.lang.String entity, java.lang.String voAlias, java.lang.String where, java.lang.Object paramValue)
FinderWrapper(java.lang.String entity, java.lang.String voAlias, java.lang.String where, java.lang.Object[] values)

Method Summary

Modifier and Type	Method and Description
void	addJoinedColumn(java.lang.String path, java.lang.String colName)
FinderWrapper	and(java.lang.String where)
java.util.Map	getAdditionalTables()
java.lang.String	getCustomColumns()
java.lang.String	getEntity()
EntityDAO.ExecutableSQLCommand	getExecutableSqlCommand()
java.util.Map	getJoinedColumns()
EntityDAO.JoinedColumnsMetadata	getJoinedColumnsMetadata()
int	getLimitedResultSize()
int	getMaxResults()
java.lang.String	getOrderBy()
FinderWrapper.Pagination	getPagination()
java.sql.Statement	getUsedStm()
java.lang.Object[]	getValues()
java.lang.String	getVoAlias()
int	getVoRetrievePolicy()
java.lang.String	getWhere()
boolean	isBuildExecutableSql()
boolean	isForUpdate()
boolean	isFowardOnly()
boolean	isIgnoreEntityCriteria()
boolean	isUseNoLock()
boolean	isUseStoredProcToQuery()
FinderWrapper	or(java.lang.String where)
void	putAdditionalTable(java.lang.String table, java.lang.String alias)
void	setBuildExecutableSql(boolean buildExecutableSql)
void	setCustomColumns(java.lang.String customColumns)
void	setExecutableSqlCommand(EntityDAO.ExecutableSQLCommand executableSqlCommand)
void	setFinderArguments(java.lang.Object[] values)
void	setForUpdate(boolean forUpdate)
void	setFowardOnly(boolean isFowardOnly)
void	setIgnoreEntityCriteria(boolean ignoreEntityCriteria)
void	setJoinedColumnsMetadata(EntityDAO.JoinedColumnsMetadata joinedColumnsMetadata)
void	setLimitedResultSize(int rows)
void	setMaxResults(int maxResults)
void	setOrderBy(java.lang.String orderBy)
void	setPagination(FinderWrapper.Pagination pagination)
void	setUsedStm(java.sql.Statement usedStm)
void	setUseNoLock(boolean useNoLock)
void	setUseStoredProcToQuery(boolean useStoredProcToQuery)
void	setVoRetrievePolicy(int voRetrievePolicy)
void	setWhere(java.lang.String where) critério da cláusula (SQL WHERE), a palavra WHERE deve ser omitida.

Methods inherited from class java.lang.Object

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

Constructor Detail

FinderWrapper

public FinderWrapper(java.lang.String entity,
                     java.lang.String voAlias,
                     java.lang.String where)

FinderWrapper

public FinderWrapper(java.lang.String entity,
                     java.lang.String voAlias,
                     java.lang.String where,
                     java.lang.Object paramValue)

FinderWrapper

public FinderWrapper(java.lang.String entity,
                     java.lang.String voAlias,
                     java.lang.String where,
                     java.lang.Object[] values)

FinderWrapper

public FinderWrapper(java.lang.String entity,
                     java.lang.String where)

FinderWrapper

public FinderWrapper(java.lang.String entity,
                     java.lang.String where,
                     java.lang.Object paramValue)

FinderWrapper

public FinderWrapper(java.lang.String entity,
                     java.lang.String where,
                     java.lang.Object[] values)

Method Detail

addJoinedColumn

public void addJoinedColumn(java.lang.String path,
                            java.lang.String colName)

getJoinedColumns

public java.util.Map getJoinedColumns()

getAdditionalTables

public java.util.Map getAdditionalTables()

getEntity

public java.lang.String getEntity()

Returns:

Nome da entidade a qual a consulta será aplicada.

getMaxResults

public int getMaxResults()

getOrderBy

public java.lang.String getOrderBy()

getValues

public java.lang.Object[] getValues()

Returns:

Parametros da consulta, pode ser nulo ou vazio.

getVoAlias

public java.lang.String getVoAlias()

getVoRetrievePolicy

public int getVoRetrievePolicy()

getWhere

public java.lang.String getWhere()

isForUpdate

public boolean isForUpdate()

isFowardOnly

public boolean isFowardOnly()

isIgnoreEntityCriteria

public boolean isIgnoreEntityCriteria()

putAdditionalTable

public void putAdditionalTable(java.lang.String table,
                               java.lang.String alias)

setFinderArguments

public void setFinderArguments(java.lang.Object[] values)

setForUpdate

public void setForUpdate(boolean forUpdate)

setFowardOnly

public void setFowardOnly(boolean isFowardOnly)

setIgnoreEntityCriteria

public void setIgnoreEntityCriteria(boolean ignoreEntityCriteria)

setMaxResults

public void setMaxResults(int maxResults)

setOrderBy

public void setOrderBy(java.lang.String orderBy)

setVoRetrievePolicy

public void setVoRetrievePolicy(int voRetrievePolicy)

setWhere

public void setWhere(java.lang.String where)

critério da cláusula (SQL WHERE), a palavra WHERE deve ser omitida.

getLimitedResultSize

public int getLimitedResultSize()

setLimitedResultSize

public void setLimitedResultSize(int rows)

getUsedStm

public java.sql.Statement getUsedStm()

setUsedStm

public void setUsedStm(java.sql.Statement usedStm)

getExecutableSqlCommand

public EntityDAO.ExecutableSQLCommand getExecutableSqlCommand()

setExecutableSqlCommand

public void setExecutableSqlCommand(EntityDAO.ExecutableSQLCommand executableSqlCommand)

isBuildExecutableSql

public boolean isBuildExecutableSql()

setBuildExecutableSql

public void setBuildExecutableSql(boolean buildExecutableSql)

setUseNoLock

public void setUseNoLock(boolean useNoLock)

isUseNoLock

public boolean isUseNoLock()

setPagination

public void setPagination(FinderWrapper.Pagination pagination)

getPagination

public FinderWrapper.Pagination getPagination()

getJoinedColumnsMetadata

public EntityDAO.JoinedColumnsMetadata getJoinedColumnsMetadata()

setJoinedColumnsMetadata

public void setJoinedColumnsMetadata(EntityDAO.JoinedColumnsMetadata joinedColumnsMetadata)

getCustomColumns

public java.lang.String getCustomColumns()

setCustomColumns

public void setCustomColumns(java.lang.String customColumns)

and

public FinderWrapper and(java.lang.String where)

or

public FinderWrapper or(java.lang.String where)

isUseStoredProcToQuery

public boolean isUseStoredProcToQuery()

setUseStoredProcToQuery

public void setUseStoredProcToQuery(boolean useStoredProcToQuery)