Java Doc for ListSqlHelper.java in » Web-Framework » aranea-mvc-1.1.1 » org » araneaframework » backend » list » helper » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Web Framework » aranea mvc 1.1.1 » org.araneaframework.backend.list.helper

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

org.araneaframework.backend.list.helper .BaseListSqlHelper

org.araneaframework.backend.list.helper .ListSqlHelper

All known Subclasses:   org.araneaframework.backend.list.helper .HSqlListSqlHelper,  org.araneaframework.backend.list.helper .OracleListSqlHelper,
ListSqlHelper
abstract public class ListSqlHelper extends BaseListSqlHelper (Code)
This class provides a standard SQL based implementation of the list. It takes care of the filtering, ordering and returning data to the web components.
See Also:   BaseListSqlHelper
author:
   Jevgeni Kabanov (ekabanov at araneaframework dot org)
author:
   Rein Raudjärv

Field Summary
protected ConverterBasedColumnReader converterBasedColumnReader

final protected static Log log

protected MappingNamingStrategyAndFields mappingNamingStrategyAndFields

protected PrefixMapNamingStrategy prefixMapNamingStrategy

protected StandardFields standardFields

protected StandardValueConverter standardValueConverter


Constructor Summary
public ListSqlHelper()
     Creates ListSqlHelper without initializing any fields.
public ListSqlHelper(DataSource dataSource)
     Creates ListSqlHelper and provides it with the DataSource.
public ListSqlHelper(ListQuery query)
     Creates ListSqlHelper initializing the appropriate fields.
public ListSqlHelper(DataSource dataSource, ListQuery query)
     Creates ListSqlHelper initializing the appropriate fields and providing it with the DataSource.

Method Summary
public void addDatabaseFieldConverter(String valueName, Converter converter)
     Adds a converter for a filter/order expression value.
public void addDatabaseFieldMapping(String fieldName, String columnName, String columnAlias)
     Adds a field name to database column name and column alias mapping.
A given field is listed in the SELECT but is not read from the ResultSet .
Parameters:
  fieldName - field name.
Parameters:
  columnName - database column name.
Parameters:
  columnAlias - database column alias.
public void addDatabaseFieldMapping(String fieldName, String columnName)
     Adds a field name to database column name mapping.
public void addFields(Fields newFields)
     Add additional "set" of fields.
public void addMapping(String fieldName, String columnName, String columnAlias)
     Adds a field name to database column name and column alias mapping.
public void addMapping(String fieldName, String columnName)
     Adds a field name to database column name.
public void addNamingStrategy(NamingStrategy namingStrategy)
     Add additional naming strategy.
protected void addNamingStrategy(NamingStrategy newNamingStrategy, boolean first)

public void addNamingStrategyAsFirst(NamingStrategy namingStrategy)
     Add additional naming strategy.
public void addResultSetDeconverterForBeanField(String beanField, Converter converter)
     Adds a deconverter for ResultSet.
public void addResultSetDeconverterForColumn(String columnName, Converter converter)
     Adds a deconverter for ResultSet.
public void addResultSetMapping(String fieldName, String columnAlias)
     Adds a field name to database column alias mapping.
public ConverterBasedColumnReader getConverterBasedColumnReader()

public MappingNamingStrategyAndFields getMappingNamingStrategyAndFields()

public PrefixMapNamingStrategy getPrefixMapNamingStrategy()

public StandardFields getStandardFields()

public StandardValueConverter getStandardValueConverter()

protected void init()

public void setConverterBasedColumnReader(ConverterBasedColumnReader converterBasedColumnReader)

public void setMappingNamingStrategyAndFields(MappingNamingStrategyAndFields mappingNamingStrategyAndFields)

public void setPrefixMapNamingStrategy(PrefixMapNamingStrategy prefixMapNamingStrategy)

public void setStandardFields(StandardFields standardFields)

public void setStandardValueConverter(StandardValueConverter standardValueConverter)


Field Detail
converterBasedColumnReader
protected ConverterBasedColumnReader converterBasedColumnReader(Code)

log
final protected static Log log(Code)

mappingNamingStrategyAndFields
protected MappingNamingStrategyAndFields mappingNamingStrategyAndFields(Code)

prefixMapNamingStrategy
protected PrefixMapNamingStrategy prefixMapNamingStrategy(Code)

standardFields
protected StandardFields standardFields(Code)

standardValueConverter
protected StandardValueConverter standardValueConverter(Code)

Constructor Detail
ListSqlHelper
public ListSqlHelper()(Code)
Creates ListSqlHelper without initializing any fields.

ListSqlHelper
public ListSqlHelper(DataSource dataSource)(Code)
Creates ListSqlHelper and provides it with the DataSource.

ListSqlHelper
public ListSqlHelper(ListQuery query)(Code)
Creates ListSqlHelper initializing the appropriate fields.

ListSqlHelper
public ListSqlHelper(DataSource dataSource, ListQuery query)(Code)
Creates ListSqlHelper initializing the appropriate fields and providing it with the DataSource.

Method Detail
addDatabaseFieldConverter
public void addDatabaseFieldConverter(String valueName, Converter converter)(Code)
Adds a converter for a filter/order expression value. The converter is used by auomatic SQL query creation according to the filter/order expressions.
Parameters:
  valueName - filter/order expression value name.
Parameters:
  converter - converter that is used by convert() method.
See Also:   ListSqlHelper.addResultSetDeconverterForBeanField(String,Converter)
See Also:   ListSqlHelper.addResultSetDeconverterForColumn(String,Converter)

addDatabaseFieldMapping
public void addDatabaseFieldMapping(String fieldName, String columnName, String columnAlias)(Code)
Adds a field name to database column name and column alias mapping.
A given field is listed in the SELECT but is not read from the ResultSet .
Parameters:
  fieldName - field name.
Parameters:
  columnName - database column name.
Parameters:
  columnAlias - database column alias.
See Also:   ListSqlHelper.addMapping(String,String,String)
See Also:   ListSqlHelper.addMapping(String,String)
See Also:   ListSqlHelper.addDatabaseFieldMapping(String,String)
See Also:   ListSqlHelper.addResultSetMapping(String,String)

addDatabaseFieldMapping
public void addDatabaseFieldMapping(String fieldName, String columnName)(Code)
Adds a field name to database column name mapping.
A given field is listed in the SELECT but is not read from the ResultSet .

The corresponding column alias is generated automatically.
Parameters:
  fieldName - field name.
Parameters:
  columnName - database column name.
See Also:   ListSqlHelper.addMapping(String,String,String)
See Also:   ListSqlHelper.addMapping(String,String)
See Also:   ListSqlHelper.addDatabaseFieldMapping(String,String,String)
See Also:   ListSqlHelper.addResultSetMapping(String,String)

addFields
public void addFields(Fields newFields)(Code)
Add additional "set" of fields.
See Also:   Fields

addMapping
public void addMapping(String fieldName, String columnName, String columnAlias)(Code)
Adds a field name to database column name and column alias mapping.
A given field is listed in the SELECT and is read from the ResultSet .
Parameters:
  fieldName - field name.
Parameters:
  columnName - database column name.
Parameters:
  columnAlias - database column alias.
See Also:   ListSqlHelper.addMapping(String,String)
See Also:   ListSqlHelper.addDatabaseFieldMapping(String,String,String)
See Also:   ListSqlHelper.addDatabaseFieldMapping(String,String)
See Also:   ListSqlHelper.addResultSetMapping(String,String)

addMapping
public void addMapping(String fieldName, String columnName)(Code)
Adds a field name to database column name.
A given field is listed in the SELECT and is read from the ResultSet .

The corresponding column alias is generated automatically.
Parameters:
  fieldName - field name.
Parameters:
  columnName - database column name.
See Also:   ListSqlHelper.addMapping(String,String,String)
See Also:   ListSqlHelper.addDatabaseFieldMapping(String,String,String)
See Also:   ListSqlHelper.addDatabaseFieldMapping(String,String)
See Also:   ListSqlHelper.addResultSetMapping(String,String)

addNamingStrategy
public void addNamingStrategy(NamingStrategy namingStrategy)(Code)
Add additional naming strategy.
The given namingStrategy is added as last in the context of OrNamingStrategy .
See Also:   NamingStrategy

addNamingStrategy
protected void addNamingStrategy(NamingStrategy newNamingStrategy, boolean first)(Code)

addNamingStrategyAsFirst
public void addNamingStrategyAsFirst(NamingStrategy namingStrategy)(Code)
Add additional naming strategy.
The given namingStrategy is added as first in the context of OrNamingStrategy .
See Also:   NamingStrategy

addResultSetDeconverterForBeanField
public void addResultSetDeconverterForBeanField(String beanField, Converter converter)(Code)
Adds a deconverter for ResultSet. The converter is used by BeanResultReader to reverseConvert() values from ResultSet into bean field format.
Parameters:
  beanField - Bean field name.
Parameters:
  converter - converter that is used by reverseConvert()method.
See Also:   ListSqlHelper.addDatabaseFieldConverter(String,Converter)
See Also:   ListSqlHelper.addResultSetDeconverterForColumn(String,Converter)
See Also:   BeanResultReader

addResultSetDeconverterForColumn
public void addResultSetDeconverterForColumn(String columnName, Converter converter)(Code)
Adds a deconverter for ResultSet. The converter is used by BeanResultReader to reverseConvert() values from ResultSet into bean field format.
Parameters:
  columnName - ResultSet column name.
Parameters:
  converter - converter that is used by reverseConvert()method.
See Also:   ListSqlHelper.addDatabaseFieldConverter(String,Converter)
See Also:   ListSqlHelper.addResultSetDeconverterForBeanField(String,Converter)
See Also:   BeanResultReader

addResultSetMapping
public void addResultSetMapping(String fieldName, String columnAlias)(Code)
Adds a field name to database column alias mapping.
A given field is not listed in the SELECT but is read from the ResultSet .

Parameters:
  fieldName - field name.
Parameters:
  columnAlias - database column name in the result set.
See Also:   ListSqlHelper.addMapping(String,String,String)
See Also:   ListSqlHelper.addMapping(String,String)
See Also:   ListSqlHelper.addDatabaseFieldMapping(String,String,String)
See Also:   ListSqlHelper.addDatabaseFieldMapping(String,String)

getConverterBasedColumnReader
public ConverterBasedColumnReader getConverterBasedColumnReader()(Code)

getMappingNamingStrategyAndFields
public MappingNamingStrategyAndFields getMappingNamingStrategyAndFields()(Code)

getPrefixMapNamingStrategy
public PrefixMapNamingStrategy getPrefixMapNamingStrategy()(Code)

getStandardFields
public StandardFields getStandardFields()(Code)
standard implementation of list of fields.

getStandardValueConverter
public StandardValueConverter getStandardValueConverter()(Code)

init
protected void init()(Code)

setConverterBasedColumnReader
public void setConverterBasedColumnReader(ConverterBasedColumnReader converterBasedColumnReader)(Code)

setMappingNamingStrategyAndFields
public void setMappingNamingStrategyAndFields(MappingNamingStrategyAndFields mappingNamingStrategyAndFields)(Code)

setPrefixMapNamingStrategy
public void setPrefixMapNamingStrategy(PrefixMapNamingStrategy prefixMapNamingStrategy)(Code)

setStandardFields
public void setStandardFields(StandardFields standardFields)(Code)

setStandardValueConverter
public void setStandardValueConverter(StandardValueConverter standardValueConverter)(Code)

Fields inherited from org.araneaframework.backend.list.helper.BaseListSqlHelper
final protected static Long DEFAULT_RANGE_START(Code)(Java Doc)
protected DataSource ds(Code)(Java Doc)
protected Fields fields(Code)(Java Doc)
protected Expression filterExpr(Code)(Java Doc)
protected SqlExpression filterSqlExpr(Code)(Java Doc)
protected Long itemRangeCount(Code)(Java Doc)
protected Long itemRangeStart(Code)(Java Doc)
protected NamingStrategy namingStrategy(Code)(Java Doc)
protected ComparatorExpression orderExpr(Code)(Java Doc)
protected SqlExpression orderSqlExpr(Code)(Java Doc)
protected ResultSetColumnReader resultSetColumnReader(Code)(Java Doc)
protected ValueConverter valueConverter(Code)(Java Doc)
protected VariableResolver variableResolver(Code)(Java Doc)

Methods inherited from org.araneaframework.backend.list.helper.BaseListSqlHelper
abstract public void addNullParam(int valueType)(Code)(Java Doc)
abstract public void addStatementParam(Object param)(Code)(Java Doc)
abstract public void addStatementParams(List params)(Code)(Java Doc)
public ResultReader createBeanResultReader(Class itemClass)(Code)(Java Doc)
protected VariableResolver createExpressionBuilderResolver()(Code)(Java Doc)
protected StandardExpressionToSqlExprBuilder createFilterSqlExpressionBuilder()(Code)(Java Doc)
protected StandardCompExprToSqlExprBuilder createOrderSqlExpressionBuilder()(Code)(Java Doc)
protected static RuntimeException createQueryFailedException(String QueryString, List queryParams, SQLException nestedException)(Code)(Java Doc)
public Object execute(ConnectionCallback action)(Code)(Java Doc)
public ListItemsData execute(ResultReader reader)(Code)(Java Doc)
public ListItemsData execute(Class itemClass)(Code)(Java Doc)
public Long executeCountSql()(Code)(Java Doc)
public List executeItemRangeSql(ResultReader reader)(Code)(Java Doc)
public List executeItemRangeSql(Class itemClass)(Code)(Java Doc)
public ConnectionCallback getCountSqlCallback()(Code)(Java Doc)
abstract protected SqlStatement getCountSqlStatement()(Code)(Java Doc)
public String getDatabaseFields()(Code)(Java Doc)
public String getDatabaseFilter()(Code)(Java Doc)
public List getDatabaseFilterParams()(Code)(Java Doc)
public String getDatabaseFilterWith(String prefix, String suffix)(Code)(Java Doc)
public String getDatabaseOrder()(Code)(Java Doc)
public List getDatabaseOrderParams()(Code)(Java Doc)
public String getDatabaseOrderWith(String prefix, String suffix)(Code)(Java Doc)
public Fields getFields()(Code)(Java Doc)
protected SqlExpression getFieldsSqlExpression()(Code)(Java Doc)
protected SqlExpression getFilterSqlExpression()(Code)(Java Doc)
public ConnectionCallback getItemRangeSqlCallback(ResultReader reader)(Code)(Java Doc)
public ConnectionCallback getListItemsDataCallback(ResultReader reader)(Code)(Java Doc)
public NamingStrategy getNamingStrategy()(Code)(Java Doc)
protected SqlExpression getOrderSqlExpression()(Code)(Java Doc)
abstract protected SqlStatement getRangeSqlStatement()(Code)(Java Doc)
public ResultSetColumnReader getResultSetColumnReader()(Code)(Java Doc)
public ValueConverter getValueConverter()(Code)(Java Doc)
protected void init()(Code)(Java Doc)
abstract public void setCountSqlQuery(String countSqlQuery)(Code)(Java Doc)
public void setDataSource(DataSource ds)(Code)(Java Doc)
public void setFields(Fields fields)(Code)(Java Doc)
public void setFilterExpression(Expression filterExpr)(Code)(Java Doc)
public void setItemRangeCount(Long itemRangeCount)(Code)(Java Doc)
public void setItemRangeStart(Long itemRangeStart)(Code)(Java Doc)
public void setListQuery(ListQuery query)(Code)(Java Doc)
public void setNamingStrategy(NamingStrategy namingStrategy)(Code)(Java Doc)
public void setOrderExpression(ComparatorExpression orderExpr)(Code)(Java Doc)
public void setResultSetColumnReader(ResultSetColumnReader resultSetColumnReader)(Code)(Java Doc)
public void setSimpleSqlQuery(String fromSql)(Code)(Java Doc)
public void setSimpleSqlQuery(String fromSql, String customWhereSql, Object[] customWhereArgs)(Code)(Java Doc)
public void setSimpleSqlQuery(String fromSql, String customWhereSql, Object[] customWhereArgs, String customOrderbySql, Object[] customOrderbyArgs)(Code)(Java Doc)
abstract public void setSqlQuery(String sqlQuery)(Code)(Java Doc)
public void setValueConverter(ValueConverter valueConverter)(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.