scaffold API Documentation: Index











Overview 
Package 
Class 
Tree 
Deprecated 
 Index 
Help 










 PREV 
 NEXT

FRAMES  
 NO FRAMES




A B C D E F G H I J K L M N O P R S T U V W

A

ABSTRACT_EXCEPTION -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
AccessBase - class org.apache.commons.scaffold.sql.AccessBase.Deprecated. Use StorageBean instead.AccessBase() -
Constructor for class org.apache.commons.scaffold.sql.AccessBase
Deprecated.  
ACTION_EXCEPTION -
Static variable in class org.apache.commons.scaffold.lang.Log
Prefix for logging exceptions.
adaptor -
Static variable in class org.apache.commons.scaffold.http.ConnectionServlet
Field to hold our instance of the connection adaptor.
ADAPTOR_DEFAULT -
Static variable in class org.apache.commons.scaffold.http.ConnectionServlet
Default type to use if parameter not set ["org.apache.scaffold.sql.ConnectionAdaptor"].
ADAPTOR_FAILED_EVENT -
Static variable in class org.apache.commons.scaffold.http.ConnectionServlet
Message to log if connector initialization fails.
ADAPTOR_KEY -
Static variable in class org.apache.commons.scaffold.http.ConnectionServlet
Default parameter for setting the default attribute name, or key, used to retrieve the datasource.
ADAPTOR_LOADING_EVENT -
Static variable in class org.apache.commons.scaffold.http.ConnectionServlet
Message for verbose logging.
ADAPTOR_PARAMETER -
Static variable in class org.apache.commons.scaffold.http.ConnectionServlet
Default parameter for setting a custom adaptor type in the servlet configuration.
add(Object) -
Method in class org.apache.commons.scaffold.model.ModelResultBase
Deprecated.  
add(Object) -
Method in interface org.apache.commons.scaffold.model.ModelResult
Deprecated. Appends the specified element to the end of the List.
add(Object) -
Method in class org.apache.commons.scaffold.util.ResultListBase
 
add(Object) -
Method in interface org.apache.commons.scaffold.util.ResultList
Appends the specified element to the end of this list (optional operation).
addAll(Collection) -
Method in class org.apache.commons.scaffold.model.ModelResultBase
Deprecated.  
addAll(Collection) -
Method in interface org.apache.commons.scaffold.model.ModelResult
Deprecated. Appends all of the elements in the specified Collection to the end of this list, in the order that they are returned by the specified Collection's Iterator.
addAll(Collection) -
Method in class org.apache.commons.scaffold.util.ResultListBase
 
addAll(Collection) -
Method in interface org.apache.commons.scaffold.util.ResultList
Appends all of the elements in the specified Collection to the end of this list, in the order that they are returned by the specified Collection's Iterator.
addLuhnDigit(String) -
Static method in class org.apache.commons.scaffold.text.ConvertUtils
Returns number with the appropriate digit appended so that is passes a "luhnCheck".
addMessage(Object) -
Method in class org.apache.commons.scaffold.model.ModelResultBase
Deprecated.  
addMessage(Object) -
Method in interface org.apache.commons.scaffold.model.ModelResult
Deprecated. Add a message to the List.
addMessage(Object) -
Method in class org.apache.commons.scaffold.util.ProcessResultBase
Add a message to the list.
addMessage(Object) -
Method in interface org.apache.commons.scaffold.util.ProcessResult
Add a message to the list.
addParam(String, String, String) -
Static method in class org.apache.commons.scaffold.text.ConvertUtils
Appends name=value parameter.
aggregate -
Variable in class org.apache.commons.scaffold.util.ProcessResultBase
Field to store the aggregate state [false].
ALLOCATE_KEY_EXCEPTION -
Static variable in class org.apache.commons.scaffold.lang.Tokens
Default message for throwing exception (en).
allocateKey() -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
 
allocateKey() -
Method in interface org.apache.commons.scaffold.util.Storable
Obtain a new primary key for this object.
APPLICATION -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 



B

BASE_LOGIC_EXECUTING -
Static variable in class org.apache.commons.scaffold.lang.Log
Executing base logic.
BaseException - exception org.apache.commons.scaffold.lang.BaseException.Base exception for additional subclasses.BaseException(String) -
Constructor for class org.apache.commons.scaffold.lang.BaseException
 
BaseException(String, Throwable) -
Constructor for class org.apache.commons.scaffold.lang.BaseException
 
BLANK_STRING -
Static variable in class org.apache.commons.scaffold.lucene.Engine
Performance optimization to ensure JVM doesn't create a new empty string whenever blankNull needs one.
blankNull(String) -
Static method in class org.apache.commons.scaffold.lucene.Engine
Convenience method to use an empty string in place of a null for indexing.



C

calculate() -
Method in class org.apache.commons.scaffold.util.Scroller
Calculate the new property values using a bean that has already had count and limit set.
calculate(int) -
Method in class org.apache.commons.scaffold.util.Scroller
Calculate the new property values using a bean that has already had count and limit set.
calculate(int, int, int, int) -
Method in class org.apache.commons.scaffold.util.Scroller
Calculate the new property values.
CANCEL -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
CARRIAGE_RETURN -
Static variable in class org.apache.commons.scaffold.text.ConvertUtils
Carriage return character.
cause -
Variable in class org.apache.commons.scaffold.lang.ChainedException
 
CAUSED_BY -
Static variable in class org.apache.commons.scaffold.lang.ChainedException
 
ChainedException - exception org.apache.commons.scaffold.lang.ChainedException.http://www.javaworld.com/javaworld/jw-08-2001/jw-0803-exceptions.htmlChainedException() -
Constructor for class org.apache.commons.scaffold.lang.ChainedException
 
ChainedException(String) -
Constructor for class org.apache.commons.scaffold.lang.ChainedException
 
ChainedException(String, Throwable) -
Constructor for class org.apache.commons.scaffold.lang.ChainedException
 
ChainedException(Throwable) -
Constructor for class org.apache.commons.scaffold.lang.ChainedException
 
CLASS -
Static variable in class org.apache.commons.scaffold.lang.Log
Partial string for assembling a message.
clear() -
Method in class org.apache.commons.scaffold.util.ResultListBase
 
clear() -
Method in interface org.apache.commons.scaffold.util.ResultList
Removes all of the elements from this list..
code -
Variable in class org.apache.commons.scaffold.util.ResultListBase
A result code, if returned by the resource layer.
COMMAND_PARAMETER -
Static variable in class org.apache.commons.scaffold.http.SetUp
Parameter to specify a new path for commands used by the application [command_path].
COMMAND_PATH -
Static variable in class org.apache.commons.scaffold.http.SetUp
Default path for commands used by application ["resources/command.properties"].
COMMAND_STORE_PATH -
Static variable in class org.apache.commons.scaffold.util.CommandStore
The path to a default properties file if not given in the constructor ["resources/command.properties"].
commands -
Static variable in class org.apache.commons.scaffold.sql.StorageBeanBase
Our command string properties.
commands -
Static variable in class org.apache.commons.scaffold.sql.AccessBase
Deprecated. Our command string properties.
CommandStore - class org.apache.commons.scaffold.util.CommandStore. CommandStore(Properties) -
Constructor for class org.apache.commons.scaffold.util.CommandStore
Constructor to pass a properties file.
ConnectionAdaptor - class org.apache.commons.scaffold.sql.ConnectionAdaptor.Base class for SQL connection adaptors.ConnectionAdaptor() -
Constructor for class org.apache.commons.scaffold.sql.ConnectionAdaptor
 
ConnectionServlet - class org.apache.commons.scaffold.http.ConnectionServlet.Initialize a ConnectionAdaptor for this application.ConnectionServlet() -
Constructor for class org.apache.commons.scaffold.http.ConnectionServlet
 
console(String) -
Static method in class org.apache.commons.scaffold.lang.Log
Convenience utility to send text to default system.out console.
consoleln(String) -
Static method in class org.apache.commons.scaffold.lang.Log
Convenience utility to send a line of text to default system.out console.
contains(Object) -
Method in class org.apache.commons.scaffold.util.ResultListBase
 
contains(Object) -
Method in interface org.apache.commons.scaffold.util.ResultList
Returns true if this collection contains the specified element.
containsAll(Collection) -
Method in class org.apache.commons.scaffold.util.ResultListBase
 
containsAll(Collection) -
Method in interface org.apache.commons.scaffold.util.ResultList
Returns true if this collection contains all of the elements in the specified collection.
CONTINUE -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
ConvertUtils - class org.apache.commons.scaffold.text.ConvertUtils.An experimental class with some standard conversion utilities.ConvertUtils() -
Constructor for class org.apache.commons.scaffold.text.ConvertUtils
 
count -
Variable in class org.apache.commons.scaffold.util.Scroller
The maximum number of entries available (the SQL count).
count -
Variable in class org.apache.commons.scaffold.util.FunctionBean
The count
counter -
Variable in class org.apache.commons.scaffold.model.ModelResultBase
Deprecated. Our counter property
counter -
Variable in class org.apache.commons.scaffold.util.ResultListBase
Our intial counter value [0].
CREATE_OBJECT_ERROR -
Static variable in class org.apache.commons.scaffold.lang.Log
Error creating object
createKey(String) -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
 
createKey(String) -
Static method in class org.apache.commons.scaffold.sql.AccessBase
Deprecated. Returns next sequential key for given set of keys.
createKey(String) -
Method in interface org.apache.commons.scaffold.util.StorageBean
Returns next sequential key for given set of keys.
createKey(String, int, String, Object, String) -
Static method in class org.apache.commons.scaffold.sql.StatementUtils
Returns next sequential key for given table.
createTable(String, String, String) -
Static method in class org.apache.commons.scaffold.sql.StatementUtils
Create a new database table in an existing database, by sending "CREATE TABLE " and the parameters to the DBMS configured with the ConnectionPool.
CURRENCY_PATTERN -
Static variable in class org.apache.commons.scaffold.text.ConvertUtils
Standard currency pattern.



D

data -
Variable in class org.apache.commons.scaffold.util.ProcessResultBase
Field to store the data property [null].
DATA_ACCESS_DENIED -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
DATA_ACCESS_EMPTY -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
DATA_ACCESS_ERROR -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
DATA_ACCESS_EXCEPTION -
Static variable in class org.apache.commons.scaffold.lang.Tokens
Default message for throwing exception (en).
DATA_RECORD_DELETED -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
DATA_RECORD_DUPLICATE -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
DATA_RECORD_INSERTED -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
DATA_RECORD_RECYCLED -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
DATA_RECORD_RESTORED -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
DATA_RECORD_RETRIEVED -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
DATA_RECORD_UPDATED -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
DATA_SOURCE_KEY -
Static variable in class org.apache.commons.scaffold.sql.ConnectionAdaptor
The default DataSource name.
DATA_TRANSFER_ERROR -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
datasource -
Static variable in class org.apache.commons.scaffold.sql.ConnectionAdaptor
Field to store singleton reference to default datasource.
DATE -
Static variable in class org.apache.commons.scaffold.lang.TestData
Date type
DEBUG -
Static variable in class org.apache.commons.scaffold.lang.Log
A programming event that developers might find interesting, like an object being created.
DECIMAL_PATTERN -
Static variable in class org.apache.commons.scaffold.text.ConvertUtils
Default decimal pattern.
DEFAULT -
Static variable in class org.apache.commons.scaffold.text.ConvertUtils
Default style for dates and times.
DEFAULT_ATTRIBUTE -
Static variable in class org.apache.commons.scaffold.http.ResourceServlet
The default attribute for the application properties.
DEFAULT_PARAMETER -
Static variable in class org.apache.commons.scaffold.http.ResourceServlet
The parameter to check for a new path to the default properties ["default"].
DEFAULT_PATH -
Static variable in class org.apache.commons.scaffold.http.ResourceServlet
The default path to use if parameter is not set ["resources/default.properties"].
DELETE -
Static variable in class org.apache.commons.scaffold.sql.StorageBeanBase
[:TODO: Javadoc] purge
delete() -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
 
delete() -
Method in interface org.apache.commons.scaffold.util.Storable
Permenantly delete record.
delete(Object) -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
[:TODO: Javadoc]
delete(Object) -
Method in interface org.apache.commons.scaffold.util.StorageBean
Permanently delete this object from data storage.
delete(Object, Integer, String) -
Static method in class org.apache.commons.scaffold.sql.AccessBase
Deprecated. Mark entry for deletion.
deleteTerm(Term) -
Static method in class org.apache.commons.scaffold.lucene.Engine
Delete record matching term from default index.
description -
Variable in class org.apache.commons.scaffold.model.ModelResultBase
Deprecated. The search description as a phrase, ie: field = value
DESTROY_EVENT -
Static variable in class org.apache.commons.scaffold.http.ResourceServlet
Message for verbose logging.
destroy() -
Method in class org.apache.commons.scaffold.http.ResourceServlet
Gracefully shut down this controller servlet, releasing any resources that were allocated at initialization.
destroyCustom() -
Method in class org.apache.commons.scaffold.http.ResourceServlet
Release any custom resources created at initialization
destroyDefault() -
Method in class org.apache.commons.scaffold.http.ResourceServlet
Release any default resources created at initialization
destroyLogging() -
Method in class org.apache.commons.scaffold.http.ResourceServlet
 
DIGESTER_LOG_PARAMETER -
Static variable in class org.apache.commons.scaffold.lang.Log
Token for setting the digester log level as a servlet init-param.
dispatch -
Variable in class org.apache.commons.scaffold.util.ProcessResultBase
Field to store dispatch property [null].
DISPATCH -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
dispatchPath -
Variable in class org.apache.commons.scaffold.util.ProcessResultBase
Field to store dispatchPath property [false].
displayName -
Variable in class org.apache.commons.scaffold.util.ResultListBase
The displayName map, if any.
DONE -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
DOT -
Static variable in class org.apache.commons.scaffold.sql.StorageBeanBase
[:TODO: Javadoc]
DOT -
Static variable in class org.apache.commons.scaffold.util.CommandStore
 



E

EMAIL_ADDRESS -
Static variable in class org.apache.commons.scaffold.lang.TestData
EmailAddress Format.
EMPTY -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
EMPTY -
Static variable in class org.apache.commons.scaffold.model.ModelBeanBase
Deprecated. A static, empty String used by isBlank.
EMPTY_STRING -
Static variable in class org.apache.commons.scaffold.text.ConvertUtils
An empty string.
Engine - class org.apache.commons.scaffold.lucene.Engine.Search engine methods for Lucene.Engine() -
Constructor for class org.apache.commons.scaffold.lucene.Engine
 
entries -
Variable in class org.apache.commons.scaffold.util.Scroller
The actual number of entries to fetch (e.g.
ERROR -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
ERROR -
Static variable in class org.apache.commons.scaffold.lang.Log
An unexpected error; must log.
ERROR_CANCEL -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
ERROR_DETAIL -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
ERROR_DISPATCH -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
ERROR_DISPATCH_RETURN -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
ERROR_GENERAL -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
ERROR_TOKEN -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
ERRORS_REQUIRED -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
ESCAPE_DATE_PATTERN -
Static variable in class org.apache.commons.scaffold.text.ConvertUtils
A "default" date format.
Executable - interface org.apache.commons.scaffold.util.Executable.Simple interface to describe public methods on a business logic object.execute() -
Method in class org.apache.commons.scaffold.util.ProcessBeanBase
Perform business logic for this bean.
execute() -
Method in interface org.apache.commons.scaffold.util.Executable
Perform business logic for this bean, often by passing default values to the Object execute(Object) signature.
execute() -
Method in interface org.apache.commons.scaffold.util.ProcessBean
Perform business logic for this bean, often by passing default values to the Object execute(Object) signature.
execute(Object) -
Method in class org.apache.commons.scaffold.model.ModelBeanBase
Deprecated. Set properties from source, perform query for this bean, and return outcome in a ModelResult collection of this QueryBean class, e.g.
execute(Object) -
Method in interface org.apache.commons.scaffold.model.ModelBean
Deprecated. Perform query for this bean, and return outcome in a ModelResult collection of this QueryBean class, e.g.
execute(Object) -
Method in class org.apache.commons.scaffold.util.ProcessBeanBase
Perform business logic for this instance by obtaining any properties from the parameters object.
execute(Object) -
Method in interface org.apache.commons.scaffold.util.Executable
Perform business logic for this, by retrieving any settings from the parameter object, and return a result object.
execute(Object) -
Method in interface org.apache.commons.scaffold.util.ProcessBean
Perform business logic for this, by retrieving any settings from the parameters object and returning a result object.
execute(Object, Object) -
Method in class org.apache.commons.scaffold.model.ModelBeanBase
Deprecated. Perform query for this bean and return outcome in a ModelResult collection of the target bean.
execute(Object, Object) -
Method in interface org.apache.commons.scaffold.model.ModelBean
Deprecated. Set properties from object, perform query for this bean, and return outcome in a ModelResult collection of the target bean.
executeQuery(Connection, String, Object[]) -
Static method in class org.apache.commons.scaffold.sql.StatementUtils
Merges a SQL command with an array of parameters.
executeUpdate(Connection, String, String, Object[]) -
Static method in class org.apache.commons.scaffold.sql.StatementUtils
Prepares statement using SQL statement and executes with DBMS configured with the ConnectionPool.
executeUpdate(String) -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
 
executeUpdate(String) -
Static method in class org.apache.commons.scaffold.sql.StatementUtils
Convenience method for calling executeUpdate(String,String,Object[]); without a parameter list.
executeUpdate(String) -
Static method in class org.apache.commons.scaffold.sql.AccessBase
Deprecated. Lookup command and execute "update" query to create a table, seed it with data, et cetera.
executeUpdate(String) -
Method in interface org.apache.commons.scaffold.util.StorageBean
Lookup command and execute "update" query to create a table, seed it with data, et cetera.
executeUpdate(String, String) -
Static method in class org.apache.commons.scaffold.sql.StatementUtils
Convenience method for calling executeUpdate(String,String,Object[]); without a parameter list.
executeUpdate(String, String, Object) -
Static method in class org.apache.commons.scaffold.sql.StatementUtils
Convenience method for calling executeUpdate(String,String,Object[]); with a single Object parameter.
executeUpdate(String, String, Object[]) -
Static method in class org.apache.commons.scaffold.sql.StatementUtils
Prepares statement using SQL statement and executes with DBMS configured with the ConnectionPool.
executeUpdateRoot(String) -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
 
executeUpdateRoot(String) -
Method in interface org.apache.commons.scaffold.util.StorageBean
Lookup command (sans prefix) and execute "update" query to create a table, seed it with data, et cetera.
EXIT -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
exposed -
Variable in class org.apache.commons.scaffold.util.ProcessResultBase
Field to store exposed property [true].



F

FAILURE -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
FILE_SEPARATOR -
Static variable in class org.apache.commons.scaffold.text.ConvertUtils
File separator character.
findByProperty(Object, String, String) -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
 
findByProperty(Object, String, String) -
Static method in class org.apache.commons.scaffold.sql.AccessBase
Deprecated. Select entries from data storage by indexed property..
findByProperty(Object, String, String) -
Method in interface org.apache.commons.scaffold.util.StorageBean
Select entries from data storage by indexed property..
findCollection(Object, String) -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
Convenience method that calls findCollection(Object,String,Object[]) with appropriate parameters.
findCollection(Object, String) -
Static method in class org.apache.commons.scaffold.sql.AccessBase
Deprecated. Retrieve a collection of beans from data stoarge.
findCollection(Object, String, int) -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
Convenience method that calls findCollection(Object,String,Object[]) with appropriate parameters.
findCollection(Object, String, int) -
Static method in class org.apache.commons.scaffold.sql.AccessBase
Deprecated. Retrieve a collection of beans from data stoarge.
findCollection(Object, String, Object) -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
Convenience method that calls findCollection(Object,String,Object[]) with appropriate parameters.
findCollection(Object, String, Object) -
Static method in class org.apache.commons.scaffold.sql.AccessBase
Deprecated. Retrieve a collection of beans from data stoarge.
findCollection(Object, String, Object[]) -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
 
findCollection(Object, String, Object[]) -
Static method in class org.apache.commons.scaffold.sql.AccessBase
Deprecated. Retrieve a collection of beans from data stoarge.
findCollection(Object, String, Object[]) -
Method in interface org.apache.commons.scaffold.util.StorageBean
Retrieve a collection of beans from data stoarge.
findCollectionLike(Object, String, String) -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
 
findCollectionLike(Object, String, String) -
Static method in class org.apache.commons.scaffold.sql.AccessBase
Deprecated. Retrieve a collection of beans from data stoarge.
findCollectionLike(Object, String, String) -
Method in interface org.apache.commons.scaffold.util.StorageBean
Retrieve a collection of beans from data stoarge.
findElement(Object, Object, String) -
Static method in class org.apache.commons.scaffold.sql.AccessBase
Deprecated. Retrieve entry from data storage.
findElement(Object, String, Object) -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
 
findElement(Object, String, Object) -
Method in interface org.apache.commons.scaffold.util.StorageBean
Retrieve object from data storage.
FORM_FEED -
Static variable in class org.apache.commons.scaffold.text.ConvertUtils
Form feed character.
FORWARD -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
from -
Variable in class org.apache.commons.scaffold.util.Scroller
The starting point for the current query [FROM].
FROM -
Static variable in class org.apache.commons.scaffold.util.Scroller
The default starting point [1].
FULL -
Static variable in class org.apache.commons.scaffold.text.ConvertUtils
Full style for dates and times.
FunctionBean - class org.apache.commons.scaffold.util.FunctionBean. FunctionBean() -
Constructor for class org.apache.commons.scaffold.util.FunctionBean
 



G

GET_TOKEN -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
get(int) -
Method in class org.apache.commons.scaffold.model.ModelResultBase
Deprecated.  
get(int) -
Method in interface org.apache.commons.scaffold.model.ModelResult
Deprecated. Returns the element at the specified position in this list.
get(int) -
Method in class org.apache.commons.scaffold.util.ResultListBase
 
get(int) -
Method in interface org.apache.commons.scaffold.util.ResultList
Returns the element at the specified position in this list.
getAnalyzer() -
Static method in class org.apache.commons.scaffold.lucene.Engine
Return default analyzer for application A non-English site should use a different analyzer
getCause() -
Method in class org.apache.commons.scaffold.lang.ChainedException
 
getCauseMessage() -
Method in class org.apache.commons.scaffold.lang.ChainedException
 
getCode() -
Method in class org.apache.commons.scaffold.util.ResultListBase
 
getCode() -
Method in interface org.apache.commons.scaffold.util.ResultList
Return the code.
getCollection(Object, Hits) -
Static method in class org.apache.commons.scaffold.lucene.SearchUtils
Return a ArrayList of hits by looping and calling populate.
getCollection(Object, ResultSet) -
Static method in class org.apache.commons.scaffold.sql.ResultSetUtils
Return a ArrayList of beans populated from a ResultSet.
getCollection(String, Object, String) -
Static method in class org.apache.commons.scaffold.sql.StatementUtils
Convenience method for calling getCollection(String,Object,String,Object[]); without a parameter list.
getCollection(String, Object, String, int) -
Static method in class org.apache.commons.scaffold.sql.StatementUtils
Convenience method for calling getCollection(String,Object,String,Object[]); with a single int parameter.
getCollection(String, Object, String, Object) -
Static method in class org.apache.commons.scaffold.sql.StatementUtils
Convenience method for calling getCollection(String,Object,String,Object[]); with a single object parameter.
getCollection(String, Object, String, Object[]) -
Static method in class org.apache.commons.scaffold.sql.StatementUtils
Merges a SQL command with an array of parameters.
getCollectionLike(String, Object, String, String) -
Static method in class org.apache.commons.scaffold.sql.StatementUtils
Convenience method to wrap a string for a command that uses the LIKE operator.
getColumn(String, int, String) -
Static method in class org.apache.commons.scaffold.sql.StatementUtils
Convenience method for calling getColumn(String,Object,String,Object[]); without a parameter list.
getColumn(String, int, String, int) -
Static method in class org.apache.commons.scaffold.sql.StatementUtils
Convenience method for calling getColumn(String,Object,String,Object[]); with a single int parameter.
getColumn(String, int, String, Object) -
Static method in class org.apache.commons.scaffold.sql.StatementUtils
Convenience method for calling getColumn(String,int,String,Object[]); with a single object parameter.
getColumn(String, int, String, Object[]) -
Static method in class org.apache.commons.scaffold.sql.StatementUtils
Merges a SQL command with an array of parameters and returns a column from the first record of the result set as an Object.
getCommand(String) -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
Retrieve command from commands Properties
getCommand(String) -
Static method in class org.apache.commons.scaffold.sql.AccessBase
Deprecated. Retrieve command from commands Properties for key.
getCommandRoot(String) -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
Retrieve command from commands Properties
getConnection() -
Method in class org.apache.commons.scaffold.sql.ConnectionAdaptor
Returns a JDBC connection from the default resource.
getConnection(String) -
Method in class org.apache.commons.scaffold.sql.ConnectionAdaptor
Returns a JDBC connection from a connection pool or other named resource, to be used and closed promptly.
getCount() -
Method in class org.apache.commons.scaffold.util.Scroller
Return count.
getCount() -
Method in class org.apache.commons.scaffold.util.FunctionBean
Return the count.
getCounter() -
Method in class org.apache.commons.scaffold.model.ModelResultBase
Deprecated.  
getCounter() -
Method in interface org.apache.commons.scaffold.model.ModelResult
Deprecated. Convenience method for maintaining a counter that can be shared among multiple components in some presentation systems (e.g, Tiles).
getCounter() -
Method in class org.apache.commons.scaffold.util.ResultListBase
 
getCounter() -
Method in interface org.apache.commons.scaffold.util.ResultList
Convenience method for maintaining a counter that can be shared among multiple components in some presentation systems (e.g, Tiles).
getCurrency(Number) -
Static method in class org.apache.commons.scaffold.text.ConvertUtils
Return currency for default locale using standard pattern.
getData() -
Method in class org.apache.commons.scaffold.util.ProcessResultBase
Return the data object.
getData() -
Method in interface org.apache.commons.scaffold.util.ProcessResult
Return the data object.
getDataSource(String) -
Method in class org.apache.commons.scaffold.sql.ConnectionAdaptor
Return datasource using JNDI lookup.
getDataSource(String) -
Method in class org.apache.commons.scaffold.sql.MockAdaptor
 
getDataSource(String) -
Method in class org.apache.commons.scaffold.sql.PoolmanAdaptor
 
getDataSource(String) -
Method in class org.apache.commons.scaffold.sql.ServletAdaptor
Return datasource from the servlet context using key as the attribute name.
getDate(Date) -
Static method in class org.apache.commons.scaffold.text.ConvertUtils
Convert date to String for default locale in DEFAULT style.
getDate(Date, int) -
Static method in class org.apache.commons.scaffold.text.ConvertUtils
Convert date to String for default locale in given style.
getDate(Date, Locale, int) -
Static method in class org.apache.commons.scaffold.text.ConvertUtils
Convert date to String for given locale in given style.
getDate(String) -
Static method in class org.apache.commons.scaffold.text.ConvertUtils
Convert String to Date using a medium (weekday day month year) format.
getDate(String, String) -
Static method in class org.apache.commons.scaffold.text.ConvertUtils
Convert String to Date using given format.
getDate(String, String, boolean) -
Static method in class org.apache.commons.scaffold.text.ConvertUtils
Convert String to Date using given format.
getDecimal(Number) -
Static method in class org.apache.commons.scaffold.text.ConvertUtils
Return decimal for default locale using standard pattern.
getDecimal(Number, Locale) -
Static method in class org.apache.commons.scaffold.text.ConvertUtils
Return decimal number formatted for default or given locale.
getDecimal(Number, Locale, String) -
Static method in class org.apache.commons.scaffold.text.ConvertUtils
Return decimal number formatted for default or given locale using given pattern.
getDescription() -
Method in class org.apache.commons.scaffold.model.ModelResultBase
Deprecated.  
getDescription() -
Method in interface org.apache.commons.scaffold.model.ModelResult
Deprecated. Return the description.
getDigits(String) -
Static method in class org.apache.commons.scaffold.text.ConvertUtils
Return String with of digits only (0..9).
getDispatch() -
Method in class org.apache.commons.scaffold.util.ProcessResultBase
The dispatch property can be used to re-route control to an non-default location, either as a system path or via a logical name (e.g ActionForward).
getDispatch() -
Method in interface org.apache.commons.scaffold.util.ProcessResult
The dispatch property can be used to re-route control to an non-default location, either as a system path or via a logical name (e.g ActionForward).
getDisplayName() -
Method in class org.apache.commons.scaffold.util.ResultListBase
 
getDisplayName() -
Method in interface org.apache.commons.scaffold.util.ResultList
Return the displayName map (a HashMap).
getElement(int) -
Method in class org.apache.commons.scaffold.util.ResultListBase
 
getElement(int) -
Method in interface org.apache.commons.scaffold.util.ResultList
Convenience accessor for get().
getElement(Object, ResultSet) -
Static method in class org.apache.commons.scaffold.sql.ResultSetUtils
Populate target bean with the first record from a ResultSet.
getElement(String, Object, String) -
Static method in class org.apache.commons.scaffold.sql.StatementUtils
Convenience method for calling getElement(String,Object,String,Object[]); without a parameter list.
getElement(String, Object, String, int) -
Static method in class org.apache.commons.scaffold.sql.StatementUtils
Convenience method for calling getElement(String,Object,String,Object[]); with a single int parameter.
getElement(String, Object, String, Object) -
Static method in class org.apache.commons.scaffold.sql.StatementUtils
Convenience method for calling getElement(String,Object,String,Object[]); with a single object parameter.
getElement(String, Object, String, Object[]) -
Static method in class org.apache.commons.scaffold.sql.StatementUtils
Merges a SQL command with an array of parameters.
getEntries() -
Method in class org.apache.commons.scaffold.util.Scroller
Return entries.
getFrom() -
Method in class org.apache.commons.scaffold.util.Scroller
Return from.
getGenericDecimal(Locale) -
Static method in class org.apache.commons.scaffold.text.ConvertUtils
Symbols that can be used in a decimal pattern.
getHits(Query) -
Static method in class org.apache.commons.scaffold.lucene.Engine
Return hits for model using default searcher.
getIndexPath() -
Static method in class org.apache.commons.scaffold.lucene.Engine
Return path for index.
getIndexReader() -
Static method in class org.apache.commons.scaffold.lucene.Engine
Return default reader for application.
getIndexWriter(boolean) -
Static method in class org.apache.commons.scaffold.lucene.Engine
Return default writer for application.
getInitInt(String, int) -
Method in class org.apache.commons.scaffold.http.ResourceServlet
Check for a parameter and returns a default value if not found, or if the value does not convert to an int.
getInitParameters() -
Method in class org.apache.commons.scaffold.http.ResourceServlet
Return a map of this servlet's initialization parameters.
getInitString(String, String) -
Method in class org.apache.commons.scaffold.http.ResourceServlet
Check for a parameter and returns a default value if not found.
getIterator() -
Method in class org.apache.commons.scaffold.model.ModelResultBase
Deprecated.  
getIterator() -
Method in interface org.apache.commons.scaffold.model.ModelResult
Deprecated. Accessor for iterator().
getIterator() -
Method in class org.apache.commons.scaffold.util.ResultListBase
 
getIterator() -
Method in interface org.apache.commons.scaffold.util.ResultList
Convenience accessor for iterator().
getKey() -
Method in class org.apache.commons.scaffold.sql.ConnectionAdaptor
Return the attribute under which our datasource is stored.
getLabel() -
Method in class org.apache.commons.scaffold.util.LabelValueBean
 
getLegend() -
Method in class org.apache.commons.scaffold.util.ResultListBase
 
getLegend() -
Method in interface org.apache.commons.scaffold.util.ResultList
Return the legend.
getLimit() -
Method in class org.apache.commons.scaffold.util.Scroller
Return limit.
getLocale() -
Method in class org.apache.commons.scaffold.util.ProcessBeanBase
 
getLocale() -
Method in interface org.apache.commons.scaffold.util.Localized
 
getLocale() -
Method in interface org.apache.commons.scaffold.util.ProcessBean
Return the locale for this bean instance.
getLogLevel() -
Method in class org.apache.commons.scaffold.http.ResourceServlet
Return the logging level for this servlet.
getMap() -
Method in interface org.apache.commons.scaffold.util.Mapped
Return a Map of this object's public properties.
getMap(ResultSet) -
Static method in class org.apache.commons.scaffold.sql.ResultSetUtils
Returns next record of result set as a Map.
getMaps(ResultSet) -
Static method in class org.apache.commons.scaffold.sql.ResultSetUtils
Return a Collection of Maps, each representing a row from the ResultSet.
getMarked() -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
Return the marked status.
getMessage() -
Method in class org.apache.commons.scaffold.sql.ConnectionAdaptor
Return a message for an exception if pool returns null.
getMessage(StringBuffer) -
Method in class org.apache.commons.scaffold.lang.ChainedException
 
getMessages() -
Method in class org.apache.commons.scaffold.model.ModelResultBase
Deprecated.  
getMessages() -
Method in interface org.apache.commons.scaffold.model.ModelResult
Deprecated. Return the messages.
getMessages() -
Method in class org.apache.commons.scaffold.util.ProcessResultBase
Return the messages list (an ArrayList).
getMessages() -
Method in interface org.apache.commons.scaffold.util.ProcessResult
Return the messages list.
getModified() -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
Return the edited timestamp.
getName() -
Method in class org.apache.commons.scaffold.util.ProcessResultBase
 
getName() -
Method in interface org.apache.commons.scaffold.util.ProcessResult
Return the attribute name for the result object.
getNext() -
Method in class org.apache.commons.scaffold.util.Scroller
Return next.
getNumber(Number, Locale) -
Static method in class org.apache.commons.scaffold.text.ConvertUtils
Returns number formatted for default or given locale.
getOffset() -
Method in class org.apache.commons.scaffold.util.Scroller
The database offset for the current query [0].
getOffsetForPage(int) -
Method in class org.apache.commons.scaffold.util.Scroller
Return first entry for given page.
getPage() -
Method in class org.apache.commons.scaffold.util.Scroller
Return current page number
getPage(int) -
Method in class org.apache.commons.scaffold.util.Scroller
Return page number for given entry.
getPages() -
Method in class org.apache.commons.scaffold.util.Scroller
Return number of pages.
getParameters(String) -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
Return the array of parameters required by insert and update commands for this object.
getParameters(String) -
Method in interface org.apache.commons.scaffold.util.StorageBean
[:TODO: Javadoc]
getPercent(Number, Locale) -
Static method in class org.apache.commons.scaffold.text.ConvertUtils
Returns percent formatted for default or given locale.
getPool() -
Static method in class org.apache.commons.scaffold.sql.ConnectionAdaptor
Return adaptor instance to use in acquiring connection.
getPrefix() -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
Return a unique identifier for this StorageBean's commands.
getPrefix() -
Method in interface org.apache.commons.scaffold.util.StorageBean
[:TODO: Javadoc]
getPrev() -
Method in class org.apache.commons.scaffold.util.Scroller
Return prev.
getPrimaryKey() -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
 
getPrimaryKey() -
Method in interface org.apache.commons.scaffold.util.Storable
Return this object's primary key.
getProperties() -
Method in class org.apache.commons.scaffold.http.ResourceServlet
Return the default properties object.
getProperties(String) -
Static method in class org.apache.commons.scaffold.util.CommandStore
 
getProperty(String, String) -
Static method in class org.apache.commons.scaffold.util.CommandStore
Retrieve command from Properties store for preface and key.
getQuery(String, String) -
Static method in class org.apache.commons.scaffold.lucene.Engine
Return hits for value and field
getReader(Socket) -
Static method in class org.apache.commons.scaffold.http.SocketUtil
Make a BufferedReader to get incoming data.
getRemoteAddr() -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
Return the String representation of an IP address expressed as an Integer, into the format usually given by the REMOTE_ADDR CGI variable, or ServletRequest.getRemoteAddr().
getRemoteNode() -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
Return the network address.
getRemoteServer() -
Method in class org.apache.commons.scaffold.util.ProcessBeanBase
 
getRemoteServer() -
Method in interface org.apache.commons.scaffold.util.ProcessBean
The remote server object for this bean instance, if any.
getResult() -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
 
getResult() -
Method in class org.apache.commons.scaffold.util.ResultListBase
 
getResult() -
Method in interface org.apache.commons.scaffold.util.Storable
Return the result object of an operation.
getResult() -
Method in interface org.apache.commons.scaffold.util.ResultList
Return the result list
getResultCode() -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
 
getResultCode() -
Method in interface org.apache.commons.scaffold.util.Storable
Return the result code from an operation.
getScope() -
Method in class org.apache.commons.scaffold.util.ProcessResultBase
Return the scope under which to store this result object.
getScope() -
Method in interface org.apache.commons.scaffold.util.ProcessResult
Return the scope under which to store this result object.
getScroller() -
Method in class org.apache.commons.scaffold.model.ModelResultBase
Deprecated.  
getScroller() -
Method in interface org.apache.commons.scaffold.model.ModelResult
Deprecated. Return our scroller.
getScroller() -
Method in class org.apache.commons.scaffold.util.ResultListBase
 
getScroller() -
Method in class org.apache.commons.scaffold.util.ProcessResultBase
 
getScroller() -
Method in interface org.apache.commons.scaffold.util.ResultList
Return our scroller.
getScrollFrom() -
Method in class org.apache.commons.scaffold.util.ProcessBeanBase
 
getScrollFrom() -
Method in interface org.apache.commons.scaffold.util.ProcessBean
Return the scrollFrom property.
getSearcher() -
Static method in class org.apache.commons.scaffold.lucene.Engine
Return default searcher for application.
getSize() -
Method in class org.apache.commons.scaffold.model.ModelResultBase
Deprecated.  
getSize() -
Method in interface org.apache.commons.scaffold.model.ModelResult
Deprecated. Accessor for size().
getSize() -
Method in class org.apache.commons.scaffold.util.ResultListBase
 
getSize() -
Method in interface org.apache.commons.scaffold.util.ResultList
Convenience accessor for size().
getThru() -
Method in class org.apache.commons.scaffold.util.Scroller
Return thru.
getTimestamp() -
Static method in class org.apache.commons.scaffold.text.ConvertUtils
Factory method to return timestamp initialized to current system time.
getTimestamp(Timestamp) -
Static method in class org.apache.commons.scaffold.text.ConvertUtils
Convert date to String for default locale in DEFAULT style.
getTimestamp(Timestamp, int) -
Static method in class org.apache.commons.scaffold.text.ConvertUtils
Convert date to String for default locale in given style.
getTimestamp(Timestamp, Locale, int) -
Static method in class org.apache.commons.scaffold.text.ConvertUtils
Convert timestamp to String for given locale in given style.
getValue() -
Method in class org.apache.commons.scaffold.util.LabelValueBean
 
getValue(Object) -
Method in interface org.apache.commons.scaffold.util.Mapped
Returns the value to which this map maps the specified key -- the equivalent of Object getMap().get(key).
getWriter(Socket) -
Static method in class org.apache.commons.scaffold.http.SocketUtil
Make a PrintWriter to send outgoing data.
GROUP_SEPARATOR -
Static variable in class org.apache.commons.scaffold.text.ConvertUtils
Group separator character.



H

HELPER_ACCESS_ERROR -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
HELPER_CREATED -
Static variable in class org.apache.commons.scaffold.lang.Log
Helper created.
HELPER_CREATING -
Static variable in class org.apache.commons.scaffold.lang.Log
Creating Helper.
HELPER_EXECUTING -
Static variable in class org.apache.commons.scaffold.lang.Log
Executing helpers.
HELPER_OUTCOME -
Static variable in class org.apache.commons.scaffold.lang.Log
Checking outcome of helper
HELPER_POPULATE -
Static variable in class org.apache.commons.scaffold.lang.Log
Populating helper
HELPER_PROCESSING -
Static variable in class org.apache.commons.scaffold.lang.Log
Helper processing.
HORIZONTAL_TABULATION -
Static variable in class org.apache.commons.scaffold.text.ConvertUtils
Horizontal tab character.
HttpClient - class org.apache.commons.scaffold.http.HttpClient.A network client that reads from a HTTP URL.HttpClient(String, int, String, String[], StringBuffer, StringBuffer) -
Constructor for class org.apache.commons.scaffold.http.HttpClient
Retrieve indicated page, returning headers and page content.



I

INDEX_LOCK -
Static variable in class org.apache.commons.scaffold.lucene.Engine
Object for synchronizing deletions to index
indexPath -
Static variable in class org.apache.commons.scaffold.lucene.Engine
Default path for index ["/var/lucene/scaffold"].
INIT_FAILED_EVENT -
Static variable in class org.apache.commons.scaffold.http.ResourceServlet
 
init() -
Method in class org.apache.commons.scaffold.http.ResourceServlet
Initialize this servlet by caling three extension points: initLogging initDefault initCustom The main extension point is initCustom The default implementation does nothing.
init(Properties) -
Static method in class org.apache.commons.scaffold.sql.StorageBeanBase
Set the Properties file to be used for SQL commands.
init(Properties) -
Static method in class org.apache.commons.scaffold.sql.AccessBase
Deprecated. Set the Properties file to be used for SQL commands.
init(String) -
Static method in class org.apache.commons.scaffold.lucene.Engine
Set path for index.
initCustom() -
Method in class org.apache.commons.scaffold.http.ResourceServlet
Initialize the custom properties or objects for this application.
initCustom() -
Method in class org.apache.commons.scaffold.http.SetUp
Initialize the SQL properties for the Artimus application.
initDefault() -
Method in class org.apache.commons.scaffold.http.ResourceServlet
Initialize the default properties for this application.
initDefault() -
Method in class org.apache.commons.scaffold.http.ConnectionServlet
Initialize the ConnectionAdaptor for this application.
initLogging() -
Method in class org.apache.commons.scaffold.http.ResourceServlet
Initialize the debugging detail level for this application servlet..
INSERT -
Static variable in class org.apache.commons.scaffold.sql.StorageBeanBase
[:TODO: Javadoc]
INSERT_EXCEPTION -
Static variable in class org.apache.commons.scaffold.lang.Tokens
Default message for throwing exception (en).
INTEGER_COUNT -
Static variable in class org.apache.commons.scaffold.lang.TestData
Integers for fields with a count, 0..2.
INTEGER_ID -
Static variable in class org.apache.commons.scaffold.lang.TestData
Integers for fields with an id, 0..2.
INTEGER_ONE -
Static variable in class org.apache.commons.scaffold.text.ConvertUtils
An Integer 1.
INTEGER_ZERO -
Static variable in class org.apache.commons.scaffold.text.ConvertUtils
An Integer 0.
INVALID_QUERY_EXCEPTION -
Static variable in class org.apache.commons.scaffold.lang.Tokens
Default message for throwing exception (en).
INVALID_SCOPE -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
isAggregate() -
Method in class org.apache.commons.scaffold.util.ProcessResultBase
Return whether the result of this ProcessResult is a collection of contains other ProcessResult objects to be handled individually.
isAggregate() -
Method in interface org.apache.commons.scaffold.util.ProcessResult
Return whether the result of this ProcessResult is a collection of contains other ProcessResult objects to be handled individually.
isBlank(Integer) -
Static method in class org.apache.commons.scaffold.text.ConvertUtils
Returns true if null or zero.
isBlank(String) -
Method in class org.apache.commons.scaffold.model.ModelBeanBase
Deprecated. Convenience method to check for a null or empty String.
isBlank(String) -
Static method in class org.apache.commons.scaffold.text.ConvertUtils
Returns true if null or trims to an empty string.
isBlankValue(String) -
Static method in class org.apache.commons.scaffold.text.ConvertUtils
Returns true if null or trims to an empty string.
isCause() -
Method in class org.apache.commons.scaffold.lang.ChainedException
 
isCurrent(Timestamp) -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
Check to see if another modified timetamp matches the one for this instance.
isData() -
Method in class org.apache.commons.scaffold.util.ProcessResultBase
Return whether data object has been set.
isData() -
Method in interface org.apache.commons.scaffold.util.ProcessResult
Return whether data object has been set.
isDebug() -
Method in class org.apache.commons.scaffold.http.ResourceServlet
Is logging set to debugging?
isDispatch() -
Method in class org.apache.commons.scaffold.util.ProcessResultBase
Return whether dispatch advice has been set.
isDispatch() -
Method in interface org.apache.commons.scaffold.util.ProcessResult
Return whether dispatch advice has been set.
isDispatchPath() -
Method in class org.apache.commons.scaffold.util.ProcessResultBase
Return whether dispatch advice is suppose to be a path or a token (e.g.
isDispatchPath() -
Method in interface org.apache.commons.scaffold.util.ProcessResult
Return whether dispatch advice is suppose to be a true path or a logical name (e.g.
isEmpty() -
Method in class org.apache.commons.scaffold.util.ResultListBase
 
isEmpty() -
Method in interface org.apache.commons.scaffold.util.ResultList
Returns true if this collection contains no elements.
isExposed() -
Method in class org.apache.commons.scaffold.util.ProcessResultBase
Return the exposed state.
isExposed() -
Method in interface org.apache.commons.scaffold.util.ProcessResult
Return the exposed state.
isLogLevel(int) -
Method in class org.apache.commons.scaffold.http.ResourceServlet
Is logging set this level or higher?
isMessages() -
Method in class org.apache.commons.scaffold.model.ModelResultBase
Deprecated.  
isMessages() -
Method in class org.apache.commons.scaffold.util.ProcessResultBase
Return whether there are any messages queued.
isMessages() -
Method in interface org.apache.commons.scaffold.util.ProcessResult
Return whether there are any messages queued.
isNew() -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
 
isNew() -
Method in interface org.apache.commons.scaffold.util.StorageBean
Return whether this is a new record, or one that has already been stored.
isNull(Timestamp) -
Static method in class org.apache.commons.scaffold.text.ConvertUtils
Return null if timestamp is null or equals "January 1, 1970 00:00:00".
isResult() -
Method in class org.apache.commons.scaffold.model.ModelResultBase
Deprecated.  
isSingleForm() -
Method in class org.apache.commons.scaffold.util.ProcessResultBase
Return the single-form state: list of 0 or more records=FALSE, exactly one record=TRUE.
isSingleForm() -
Method in interface org.apache.commons.scaffold.util.ProcessResult
Return the single-form state: list of 0 or more records=FALSE, exactly one record=TRUE.
isVerbose() -
Method in class org.apache.commons.scaffold.http.ResourceServlet
Is logging set to verbose?
iterator() -
Method in class org.apache.commons.scaffold.model.ModelResultBase
Deprecated.  
iterator() -
Method in interface org.apache.commons.scaffold.model.ModelResult
Deprecated. Return an iterator for the List, or null if there is no List.
iterator() -
Method in class org.apache.commons.scaffold.util.ResultListBase
 
iterator() -
Method in interface org.apache.commons.scaffold.util.ResultList
Return an iterator for the List.



J

JNDI_CONTEXT_KEY -
Static variable in class org.apache.commons.scaffold.sql.ConnectionAdaptor
The default JNDI context for applications.



K

key -
Variable in class org.apache.commons.scaffold.sql.ConnectionAdaptor
The attribute under which our DataSource is stored [DATA_SOURCE_KEY].
KEYS_INC -
Static variable in class org.apache.commons.scaffold.sql.StorageBeanBase
[:TODO: Javadoc]
KEYS_INC -
Static variable in class org.apache.commons.scaffold.sql.AccessBase
Deprecated. [:TODO: Javadoc]
KEYS_NEXT -
Static variable in class org.apache.commons.scaffold.sql.StorageBeanBase
[:TODO: Javadoc]
KEYS_NEXT -
Static variable in class org.apache.commons.scaffold.sql.AccessBase
Deprecated. [:TODO: Javadoc]
keys(StringBuffer, Map) -
Static method in class org.apache.commons.scaffold.text.Merge
Merge a Map of tokens with a template in a StringBuffer.



L

label -
Variable in class org.apache.commons.scaffold.util.LabelValueBean
The label to be displayed to the user.
LabelValueBean - class org.apache.commons.scaffold.util.LabelValueBean.Simple JavaBean to represent label-value pairs for use in collections that are utilized by the <form:options> tag.LabelValueBean(String, String) -
Constructor for class org.apache.commons.scaffold.util.LabelValueBean
Construct a new LabelValueBean with the specified values.
legend -
Variable in class org.apache.commons.scaffold.util.ResultListBase
A phrase describing the result list.
LENIENT_DATE -
Static variable in class org.apache.commons.scaffold.text.ConvertUtils
Default lenient setting for getDate.
limit -
Variable in class org.apache.commons.scaffold.util.Scroller
The maximum number of entries to fetch at a time [Integer.MAX_VALUE].
LINE_FEED -
Static variable in class org.apache.commons.scaffold.text.ConvertUtils
Line feed character.
LIST_KEY -
Static variable in class org.apache.commons.scaffold.lang.Tokens
Default key for a result or list object.
loadProperties(Object, String) -
Static method in class org.apache.commons.scaffold.util.ResourceUtils
Load a properties file.
loadProperties(String) -
Static method in class org.apache.commons.scaffold.util.ResourceUtils
 
loadProperties(String, String, String) -
Method in class org.apache.commons.scaffold.http.ResourceServlet
A utility method for loading a Properties file specified by an initialization parameter.
loadPropertiesFile(String) -
Static method in class org.apache.commons.scaffold.util.ResourceUtils
Load a properties file.
locale -
Variable in class org.apache.commons.scaffold.util.ProcessBeanBase
The locale for this bean instance, if any.
Localized - interface org.apache.commons.scaffold.util.Localized. Log - class org.apache.commons.scaffold.lang.Log.Constants for use with logging.LOG_LEVEL_PARAMETER -
Static variable in class org.apache.commons.scaffold.lang.Log
Token for setting the log level as a servlet init-param.
Log() -
Constructor for class org.apache.commons.scaffold.lang.Log
 
log(String, int) -
Method in class org.apache.commons.scaffold.http.ResourceServlet
Log the specified message if the current debugging detail level for this servlet has been set to an equal or higher value.
logLevel -
Variable in class org.apache.commons.scaffold.http.ResourceServlet
The logging level for this servlet.
LOGOFF -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
LOGON -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
LOGON_INVALID_KEY -
Static variable in class org.apache.commons.scaffold.model.ModelSecurityException
 
LONG -
Static variable in class org.apache.commons.scaffold.text.ConvertUtils
Long style for dates and times.
luhnCheck(String) -
Static method in class org.apache.commons.scaffold.text.ConvertUtils
 



M

Mapped - interface org.apache.commons.scaffold.util.Mapped.Simple interface to describe an object that can set and return its public properties via a Map.marked -
Variable in class org.apache.commons.scaffold.sql.StorageBeanBase
The marked status of the record.
MEDIUM -
Static variable in class org.apache.commons.scaffold.text.ConvertUtils
Medium style for dates and times.
MENU -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
Merge - class org.apache.commons.scaffold.text.Merge.Merge utilities.Merge() -
Constructor for class org.apache.commons.scaffold.text.Merge
 
message -
Variable in class org.apache.commons.scaffold.sql.ConnectionAdaptor
A message for an exception if pool returns null.
MESSAGE -
Static variable in class org.apache.commons.scaffold.lang.PopulateException
 
MESSAGE -
Static variable in class org.apache.commons.scaffold.lang.ParameterException
 
MESSAGE -
Static variable in class org.apache.commons.scaffold.lang.ResourceException
 
MESSAGE -
Static variable in class org.apache.commons.scaffold.lang.PropertiesException
 
MESSAGE -
Static variable in class org.apache.commons.scaffold.model.ModelAbstractException
Deprecated.  
MESSAGE -
Static variable in class org.apache.commons.scaffold.model.ModelParameterException
Deprecated.  
MESSAGE -
Static variable in class org.apache.commons.scaffold.model.ModelResourceException
Deprecated.  
MESSAGE -
Static variable in class org.apache.commons.scaffold.model.ModelPopulateException
Deprecated.  
messages -
Variable in class org.apache.commons.scaffold.model.ModelResultBase
Deprecated. The Message List.
messages -
Variable in class org.apache.commons.scaffold.util.ProcessResultBase
Field to store the message property [ArrayList].
MockAdaptor - class org.apache.commons.scaffold.sql.MockAdaptor. MockAdaptor() -
Constructor for class org.apache.commons.scaffold.sql.MockAdaptor
 
ModelAbstractException - exception org.apache.commons.scaffold.model.ModelAbstractException.Deprecated. Replaced by lang.BaseExceptionModelAbstractException() -
Constructor for class org.apache.commons.scaffold.model.ModelAbstractException
Deprecated.  
ModelAbstractException(String) -
Constructor for class org.apache.commons.scaffold.model.ModelAbstractException
Deprecated.  
ModelAbstractException(String, Throwable) -
Constructor for class org.apache.commons.scaffold.model.ModelAbstractException
Deprecated.  
ModelAbstractException(Throwable) -
Constructor for class org.apache.commons.scaffold.model.ModelAbstractException
Deprecated.  
ModelBean - interface org.apache.commons.scaffold.model.ModelBean.Deprecated. Replaced by util.ProcessBeanModelBeanBase - class org.apache.commons.scaffold.model.ModelBeanBase.Deprecated. Replaced by util.ProcessBeanBaseModelBeanBase() -
Constructor for class org.apache.commons.scaffold.model.ModelBeanBase
Deprecated.  
ModelException - exception org.apache.commons.scaffold.model.ModelException.Deprecated.  ModelException(String) -
Constructor for class org.apache.commons.scaffold.model.ModelException
Deprecated.  
ModelException(String, Throwable) -
Constructor for class org.apache.commons.scaffold.model.ModelException
Deprecated.  
ModelParameterException - exception org.apache.commons.scaffold.model.ModelParameterException.Deprecated. Replaced by lang.ParamExceptionModelParameterException() -
Constructor for class org.apache.commons.scaffold.model.ModelParameterException
Deprecated.  
ModelParameterException(String) -
Constructor for class org.apache.commons.scaffold.model.ModelParameterException
Deprecated.  
ModelParameterException(String, Throwable) -
Constructor for class org.apache.commons.scaffold.model.ModelParameterException
Deprecated.  
ModelParameterException(Throwable) -
Constructor for class org.apache.commons.scaffold.model.ModelParameterException
Deprecated.  
ModelPopulateException - exception org.apache.commons.scaffold.model.ModelPopulateException.Deprecated. Use lang.PopulateException insteadModelPopulateException() -
Constructor for class org.apache.commons.scaffold.model.ModelPopulateException
Deprecated.  
ModelPopulateException(String) -
Constructor for class org.apache.commons.scaffold.model.ModelPopulateException
Deprecated.  
ModelPopulateException(String, Throwable) -
Constructor for class org.apache.commons.scaffold.model.ModelPopulateException
Deprecated.  
ModelPopulateException(Throwable) -
Constructor for class org.apache.commons.scaffold.model.ModelPopulateException
Deprecated.  
ModelResourceException - exception org.apache.commons.scaffold.model.ModelResourceException.Deprecated. Replaced by lang.Resource ExceptionModelResourceException() -
Constructor for class org.apache.commons.scaffold.model.ModelResourceException
Deprecated.  
ModelResourceException(String) -
Constructor for class org.apache.commons.scaffold.model.ModelResourceException
Deprecated.  
ModelResourceException(String, Throwable) -
Constructor for class org.apache.commons.scaffold.model.ModelResourceException
Deprecated.  
ModelResourceException(Throwable) -
Constructor for class org.apache.commons.scaffold.model.ModelResourceException
Deprecated.  
ModelResult - interface org.apache.commons.scaffold.model.ModelResult.Deprecated. Replaced by util.ResultListModelResultBase - class org.apache.commons.scaffold.model.ModelResultBase.Deprecated. Replaced by util.ResultListBaseModelResultBase() -
Constructor for class org.apache.commons.scaffold.model.ModelResultBase
Deprecated. Default constructor.
ModelResultBase(Collection) -
Constructor for class org.apache.commons.scaffold.model.ModelResultBase
Deprecated. Convenience constructor to populate result with a Collection (e.g.
ModelResultBase(Object) -
Constructor for class org.apache.commons.scaffold.model.ModelResultBase
Deprecated. Convenience constructor to populate result with a ModelBean.
ModelSecurityException - exception org.apache.commons.scaffold.model.ModelSecurityException.Exception for error accessing a resource needed for a model (index file, data file).ModelSecurityException() -
Constructor for class org.apache.commons.scaffold.model.ModelSecurityException
 
ModelSecurityException(String) -
Constructor for class org.apache.commons.scaffold.model.ModelSecurityException
 
ModelSecurityException(String, Throwable) -
Constructor for class org.apache.commons.scaffold.model.ModelSecurityException
 
ModelSecurityException(Throwable) -
Constructor for class org.apache.commons.scaffold.model.ModelSecurityException
 
ModelUtils - class org.apache.commons.scaffold.model.ModelUtils.Deprecated.  ModelUtils() -
Constructor for class org.apache.commons.scaffold.model.ModelUtils
Deprecated.  
modified -
Variable in class org.apache.commons.scaffold.sql.StorageBeanBase
The timestamp of the last edit.



N

name -
Variable in class org.apache.commons.scaffold.util.ProcessResultBase
The attribute name for the result [null].
NAME -
Static variable in class org.apache.commons.scaffold.lang.Log
Partial string for assembling a message.
next -
Variable in class org.apache.commons.scaffold.util.Scroller
The starting point to use with a "forward" query.
NEXT -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
NOT_FOUND -
Static variable in class org.apache.commons.scaffold.lang.Log
Partial string for assembling a message.
NOT_IMPLEMENTED_EXCEPTION -
Static variable in class org.apache.commons.scaffold.lang.Tokens
Default message for throwing exception (en).
NULL_TIME -
Static variable in class org.apache.commons.scaffold.text.ConvertUtils
Value needed to create Timestamp representing "January 1, 1970 00:00:00".
NULL_TIMESTAMP -
Static variable in class org.apache.commons.scaffold.text.ConvertUtils
Timestamp representing "January 1, 1970 00:00:00".
NULL_TIMESTAMP_TEXT -
Static variable in class org.apache.commons.scaffold.text.ConvertUtils
Escape string to create Timestamp representing "January 1, 1970 00:00:00".
nullParams -
Static variable in class org.apache.commons.scaffold.sql.StatementUtils
Used to select correct executeUpdate signature.



O

OK -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
org.apache.commons.scaffold.http - package org.apache.commons.scaffold.http org.apache.commons.scaffold.lang - package org.apache.commons.scaffold.lang org.apache.commons.scaffold.lucene - package org.apache.commons.scaffold.lucene org.apache.commons.scaffold.model - package org.apache.commons.scaffold.model org.apache.commons.scaffold.sql - package org.apache.commons.scaffold.sql org.apache.commons.scaffold.text - package org.apache.commons.scaffold.text org.apache.commons.scaffold.util - package org.apache.commons.scaffold.util 


P

PARAM_ANY -
Static variable in class org.apache.commons.scaffold.lang.Tokens
The wild card character to represent a blank select.
PARAM_ANY -
Static variable in interface org.apache.commons.scaffold.model.ModelResult
Deprecated. The wild card character for a blank select.
PARAM_EQUALS -
Static variable in class org.apache.commons.scaffold.lang.Tokens
The equality indicator to represent name = value.
PARAM_EQUALS -
Static variable in interface org.apache.commons.scaffold.model.ModelResult
Deprecated. The equality indicator for description property.
ParameterException - exception org.apache.commons.scaffold.lang.ParameterException.Exception for error accessing a resource needed for a model (index file, data file).ParameterException() -
Constructor for class org.apache.commons.scaffold.lang.ParameterException
 
ParameterException(String) -
Constructor for class org.apache.commons.scaffold.lang.ParameterException
 
ParameterException(String, Throwable) -
Constructor for class org.apache.commons.scaffold.lang.ParameterException
 
ParameterException(Throwable) -
Constructor for class org.apache.commons.scaffold.lang.ParameterException
 
parameters -
Variable in class org.apache.commons.scaffold.sql.StorageBeanBase
The array of parameters required by the insert and update commands for this object.
PATH -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
PATH -
Static variable in class org.apache.commons.scaffold.lang.Log
Partial string for assembling a message.
pool -
Static variable in class org.apache.commons.scaffold.sql.ConnectionAdaptor
Field to store singleton reference to adaptor pool.
POOLMAN_MESSAGE -
Static variable in class org.apache.commons.scaffold.sql.PoolmanAdaptor
An exception message to throw if poolman returns null.
PoolmanAdaptor - class org.apache.commons.scaffold.sql.PoolmanAdaptor. PoolmanAdaptor() -
Constructor for class org.apache.commons.scaffold.sql.PoolmanAdaptor
 
populate(Map) -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
 
populate(Map) -
Method in interface org.apache.commons.scaffold.util.StorageBean
Populate this bean from the entries on the provided map.
populate(Map) -
Method in interface org.apache.commons.scaffold.util.Storable
Populate this object from a Map.
populate(Object) -
Method in class org.apache.commons.scaffold.model.ModelBeanBase
Deprecated. Populate matching properties on given object.
populate(Object) -
Method in interface org.apache.commons.scaffold.model.ModelBean
Deprecated. Populate matching properties on given object.
populate(Object, Document) -
Static method in class org.apache.commons.scaffold.lucene.SearchUtils
Populate the properties of the specified JavaBean from the specified Lucene document, based on matching each parameter name against the corresponding JavaBeans "property setter" methods in the bean's class.
populate(Object, int) -
Method in class org.apache.commons.scaffold.model.ModelResultBase
Deprecated.  
populate(Object, int) -
Method in interface org.apache.commons.scaffold.model.ModelResult
Deprecated. Populate matching properties on given object, using bean at given index.
populate(Object, int) -
Method in class org.apache.commons.scaffold.util.ResultListBase
 
populate(Object, int) -
Method in interface org.apache.commons.scaffold.util.ResultList
Populate matching properties on given object, using bean at given index.
populate(Object, Object) -
Static method in class org.apache.commons.scaffold.model.ModelUtils
Deprecated. Populate the JavaBeans properties of the target bean, based on the public accessors of the source bean.
PopulateException - exception org.apache.commons.scaffold.lang.PopulateException.Exception for error populating object.PopulateException() -
Constructor for class org.apache.commons.scaffold.lang.PopulateException
 
PopulateException(String) -
Constructor for class org.apache.commons.scaffold.lang.PopulateException
 
PopulateException(String, Throwable) -
Constructor for class org.apache.commons.scaffold.lang.PopulateException
 
PopulateException(Throwable) -
Constructor for class org.apache.commons.scaffold.lang.PopulateException
 
prefix -
Variable in class org.apache.commons.scaffold.sql.StorageBeanBase
A unique identifier for this StorageBean's commands.
prev -
Variable in class org.apache.commons.scaffold.util.Scroller
The starting point to use for a "backward" query.
PREVIOUS -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
primaryKey -
Variable in class org.apache.commons.scaffold.sql.StorageBeanBase
A storage location for the primaryKey object.
printStackTrace() -
Method in class org.apache.commons.scaffold.lang.ChainedException
 
printStackTrace(PrintStream) -
Method in class org.apache.commons.scaffold.lang.ChainedException
 
printStackTrace(PrintWriter) -
Method in class org.apache.commons.scaffold.lang.ChainedException
 
PROCESS_BEAN_NULL_SCOPE -
Static variable in class org.apache.commons.scaffold.lang.Log
Bean helper
PROCESS_COMPLETE -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
PROCESS_MISSING_PARAMETER -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
PROCESS_RESULT_NULL -
Static variable in class org.apache.commons.scaffold.lang.Log
Process action - Business method should not return null.
ProcessBean - interface org.apache.commons.scaffold.util.ProcessBean.Simple helper bean that can be used to encapsulate a method representing a business process.ProcessBeanBase - class org.apache.commons.scaffold.util.ProcessBeanBase.Base implementation of ProcessBean with default functionality.ProcessBeanBase() -
Constructor for class org.apache.commons.scaffold.util.ProcessBeanBase
 
ProcessResult - interface org.apache.commons.scaffold.util.ProcessResult.Convenient wrapper for the result of a process.ProcessResultBase - class org.apache.commons.scaffold.util.ProcessResultBase.Concrete implementation of ProcessResult that can be used "as-is" to manage a response from the business tier.ProcessResultBase() -
Constructor for class org.apache.commons.scaffold.util.ProcessResultBase
Default constructor.
ProcessResultBase(Object) -
Constructor for class org.apache.commons.scaffold.util.ProcessResultBase
Convenience constructor to set result object.
ProcessResultBase(Object, boolean) -
Constructor for class org.apache.commons.scaffold.util.ProcessResultBase
Convenience constructor to set result object and singleForm status.
ProcessResultBase(String) -
Constructor for class org.apache.commons.scaffold.util.ProcessResultBase
Convenience constructor to set forwarding advice.
properties -
Variable in class org.apache.commons.scaffold.http.ResourceServlet
Our default properties object.
properties -
Static variable in class org.apache.commons.scaffold.util.CommandStore
Our Properties field.
PROPERTIES_KEY -
Static variable in class org.apache.commons.scaffold.lang.Tokens
Default key for application properties.
PropertiesException - exception org.apache.commons.scaffold.lang.PropertiesException.Exception for error populating object.PropertiesException() -
Constructor for class org.apache.commons.scaffold.lang.PropertiesException
 
PropertiesException(String) -
Constructor for class org.apache.commons.scaffold.lang.PropertiesException
 
PropertiesException(String, Throwable) -
Constructor for class org.apache.commons.scaffold.lang.PropertiesException
 
PropertiesException(Throwable) -
Constructor for class org.apache.commons.scaffold.lang.PropertiesException
 
putEntry(Map, ResultSetMetaData, ResultSet, int) -
Static method in class org.apache.commons.scaffold.sql.ResultSetUtils
Map JDBC objects to Java equivalents.



R

RECORD_SEPARATOR -
Static variable in class org.apache.commons.scaffold.text.ConvertUtils
Record separator character.
RECYCLE -
Static variable in class org.apache.commons.scaffold.sql.StorageBeanBase
[:TODO: Javadoc] delete
recycle() -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
 
recycle() -
Method in interface org.apache.commons.scaffold.util.Storable
Mark entry for deletion.
recycle(Object) -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
 
recycle(Object) -
Method in interface org.apache.commons.scaffold.util.StorageBean
Mark this object for deletion.
RELOAD_EVENT -
Static variable in class org.apache.commons.scaffold.http.ResourceServlet
Message for verbose logging.
reload() -
Method in class org.apache.commons.scaffold.http.ResourceServlet
Reload the configuration of this controller servlet from our underlying configuration files.
remoteNode -
Variable in class org.apache.commons.scaffold.sql.StorageBeanBase
The network address of the last editor.
remove(Object) -
Method in class org.apache.commons.scaffold.util.ResultListBase
 
remove(Object) -
Method in interface org.apache.commons.scaffold.util.ResultList
Removes a single instance of the specified element from this collection, if it is present (optional operation).
removeAll(Collection) -
Method in class org.apache.commons.scaffold.util.ResultListBase
 
removeAll(Collection) -
Method in interface org.apache.commons.scaffold.util.ResultList
Removes all this collection's elements that are also contained in the specified collection.
REQUEST -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
RESOURCE_LOADING -
Static variable in class org.apache.commons.scaffold.http.ResourceServlet
Message for verbose logging.
RESOURCE_NOT_FOUND -
Static variable in class org.apache.commons.scaffold.http.ResourceServlet
Message to log if resource is not found.
RESOURCE_NOT_FOUND -
Static variable in class org.apache.commons.scaffold.util.ResourceUtils
Message to log if resource is not found.
ResourceException - exception org.apache.commons.scaffold.lang.ResourceException.Exception for error accessing a resource needed for a model (index file, data file).ResourceException() -
Constructor for class org.apache.commons.scaffold.lang.ResourceException
 
ResourceException(String) -
Constructor for class org.apache.commons.scaffold.lang.ResourceException
 
ResourceException(String, Throwable) -
Constructor for class org.apache.commons.scaffold.lang.ResourceException
 
ResourceException(Throwable) -
Constructor for class org.apache.commons.scaffold.lang.ResourceException
 
ResourceServlet - class org.apache.commons.scaffold.http.ResourceServlet.Base servlet for loading application resources.ResourceServlet() -
Constructor for class org.apache.commons.scaffold.http.ResourceServlet
 
ResourceUtils - class org.apache.commons.scaffold.util.ResourceUtils.Property and Resource utilities.ResourceUtils() -
Constructor for class org.apache.commons.scaffold.util.ResourceUtils
 
RESTORE -
Static variable in class org.apache.commons.scaffold.sql.StorageBeanBase
[:TODO: Javadoc]
restore() -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
Unmark entry for deletion.
restore() -
Method in interface org.apache.commons.scaffold.util.Storable
Unmark entry for deletion.
restore(Object) -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
Update indicated entry in data storage.
restore(Object) -
Method in interface org.apache.commons.scaffold.util.StorageBean
Unmake this object for deletion.
restore(Object, Integer, String) -
Static method in class org.apache.commons.scaffold.sql.AccessBase
Deprecated. Unmark entry for deletion.
result -
Variable in class org.apache.commons.scaffold.model.ModelResultBase
Deprecated. Our result list.
result -
Variable in class org.apache.commons.scaffold.sql.StorageBeanBase
[:TODO: Javadoc]
result -
Variable in class org.apache.commons.scaffold.util.ResultListBase
The result list [ArrayList].
RESULT -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
resultCode -
Variable in class org.apache.commons.scaffold.sql.StorageBeanBase
[:TODO: Javadoc]
ResultList - interface org.apache.commons.scaffold.util.ResultList.A container for a set of results returned from the resource tier.ResultListBase - class org.apache.commons.scaffold.util.ResultListBase.Concrete implementation of ResultList.ResultListBase() -
Constructor for class org.apache.commons.scaffold.util.ResultListBase
Default constructor.
ResultListBase(Collection) -
Constructor for class org.apache.commons.scaffold.util.ResultListBase
Convenience constructor to populate result with a Collection.
ResultListBase(Object) -
Constructor for class org.apache.commons.scaffold.util.ResultListBase
Convenience constructor to populate result with an element.
ResultSetUtils - class org.apache.commons.scaffold.sql.ResultSetUtils.General purpose utility methods related to ResultSetsResultSetUtils() -
Constructor for class org.apache.commons.scaffold.sql.ResultSetUtils
 
retainAll(Collection) -
Method in class org.apache.commons.scaffold.util.ResultListBase
 
retainAll(Collection) -
Method in interface org.apache.commons.scaffold.util.ResultList
Retains only the elements in this collection that are contained in the specified collection.
RETRIEVE -
Static variable in class org.apache.commons.scaffold.sql.StorageBeanBase
[:TODO: Javadoc]
retrieve() -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
 
retrieve() -
Method in interface org.apache.commons.scaffold.util.Storable
Retrieve record from storage.
retrieve(Object) -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
 
retrieve(Object) -
Method in interface org.apache.commons.scaffold.util.StorageBean
Retrieve this object from storage.



S

scope -
Variable in class org.apache.commons.scaffold.util.ProcessResultBase
Field to store the scope property [request].
scroller -
Variable in class org.apache.commons.scaffold.model.ModelResultBase
Deprecated. Our scroller object for paging through lists.
scroller -
Variable in class org.apache.commons.scaffold.util.ResultListBase
Our scroller object for paging through lists.
scroller -
Variable in class org.apache.commons.scaffold.util.ProcessResultBase
Our scroller object for paging through lists.
Scroller - class org.apache.commons.scaffold.util.Scroller.Scroller tracks the coordinates needed to manage flipping through a result list using LIMIT and OFFSET clauses (or the equivalent).Scroller() -
Constructor for class org.apache.commons.scaffold.util.Scroller
 
Scroller(int, int, int) -
Constructor for class org.apache.commons.scaffold.util.Scroller
 
scrollFrom -
Variable in class org.apache.commons.scaffold.util.ProcessBeanBase
The entry (or page) from which to scroll [0].
SearchUtils - class org.apache.commons.scaffold.lucene.SearchUtils.General purpose utility methods related to HitsSearchUtils() -
Constructor for class org.apache.commons.scaffold.lucene.SearchUtils
 
SELECT_EXCEPTION -
Static variable in class org.apache.commons.scaffold.lang.Tokens
Default message for throwing exception (en).
SEPARATORS -
Static variable in class org.apache.commons.scaffold.text.ConvertUtils
Array of line separator characters.
server -
Variable in class org.apache.commons.scaffold.util.ProcessBeanBase
The remote server object for this bean instance, if any.
servlet -
Static variable in class org.apache.commons.scaffold.sql.ServletAdaptor
Field to store a link to a servlet in the application.
ServletAdaptor - class org.apache.commons.scaffold.sql.ServletAdaptor.Connection adaptor for a connection pool that is exposed through the servlet context, like the Struts generic connection pool.ServletAdaptor() -
Constructor for class org.apache.commons.scaffold.sql.ServletAdaptor
 
SESSION -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
SET_TOKEN -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 
set(Object) -
Method in class org.apache.commons.scaffold.model.ModelBeanBase
Deprecated. Set properties from given object.
set(Object) -
Method in interface org.apache.commons.scaffold.model.ModelBean
Deprecated. Set properties from given object.
setAggregate(boolean) -
Method in class org.apache.commons.scaffold.util.ProcessResultBase
Assign a new container state.
setAggregate(boolean) -
Method in interface org.apache.commons.scaffold.util.ProcessResult
Assign a new container state.
setCode(Integer) -
Method in class org.apache.commons.scaffold.util.ResultListBase
 
setCode(Integer) -
Method in interface org.apache.commons.scaffold.util.ResultList
Set the code.
setCount(int) -
Method in class org.apache.commons.scaffold.util.Scroller
Set count
setCount(Integer) -
Method in class org.apache.commons.scaffold.util.FunctionBean
Set the count.
setCounter(int) -
Method in class org.apache.commons.scaffold.model.ModelResultBase
Deprecated.  
setCounter(int) -
Method in interface org.apache.commons.scaffold.model.ModelResult
Deprecated. Set a new counter value.
setCounter(int) -
Method in class org.apache.commons.scaffold.util.ResultListBase
 
setCounter(int) -
Method in interface org.apache.commons.scaffold.util.ResultList
Set a new counter value.
setData(Object) -
Method in class org.apache.commons.scaffold.util.ProcessResultBase
Assign a new data object.
setData(Object) -
Method in interface org.apache.commons.scaffold.util.ProcessResult
Assign a new data object.
setDescription(String) -
Method in class org.apache.commons.scaffold.model.ModelResultBase
Deprecated.  
setDescription(String) -
Method in interface org.apache.commons.scaffold.model.ModelResult
Deprecated. Set the description.
setDescription(String, String) -
Method in class org.apache.commons.scaffold.model.ModelResultBase
Deprecated.  
setDescription(String, String) -
Method in interface org.apache.commons.scaffold.model.ModelResult
Deprecated. Set the description as "field = value".
setDispatch(String) -
Method in class org.apache.commons.scaffold.util.ProcessResultBase
Set the dispatch advice.
setDispatch(String) -
Method in interface org.apache.commons.scaffold.util.ProcessResult
Field to store dispatch property.
setDispatchPath(boolean) -
Method in class org.apache.commons.scaffold.util.ProcessResultBase
Set the dispatchPath state.
setDispatchPath(boolean) -
Method in interface org.apache.commons.scaffold.util.ProcessResult
Indicates whether dispatch advice (if any) is suppose to be a path or a logical name (e.g.
setDisplayName(Map) -
Method in class org.apache.commons.scaffold.util.ResultListBase
 
setDisplayName(Map) -
Method in interface org.apache.commons.scaffold.util.ResultList
Assign a new displayName list.
setEntries(int) -
Method in class org.apache.commons.scaffold.util.Scroller
Set entries
setExposed(boolean) -
Method in class org.apache.commons.scaffold.util.ProcessResultBase
Indicates whether the result should be exposed to the rest of the application through a context.
setExposed(boolean) -
Method in interface org.apache.commons.scaffold.util.ProcessResult
Indicates whether the result should be exposed to the rest of the application through a context.
setFrom(int) -
Method in class org.apache.commons.scaffold.util.Scroller
Set from.
setKey(String) -
Method in class org.apache.commons.scaffold.sql.ConnectionAdaptor
The attribute under which our datasource is stored.
setLegend(String) -
Method in class org.apache.commons.scaffold.util.ResultListBase
 
setLegend(String) -
Method in interface org.apache.commons.scaffold.util.ResultList
Set the legend.
setLegend(String, String) -
Method in class org.apache.commons.scaffold.util.ResultListBase
 
setLegend(String, String) -
Method in interface org.apache.commons.scaffold.util.ResultList
Set the legend.
setLimit(int) -
Method in class org.apache.commons.scaffold.util.Scroller
Set limit.
setLocale(Locale) -
Method in class org.apache.commons.scaffold.util.ProcessBeanBase
 
setLocale(Locale) -
Method in interface org.apache.commons.scaffold.util.Localized
 
setLocale(Locale) -
Method in interface org.apache.commons.scaffold.util.ProcessBean
Set the locale for this bean instance.
setLogLevel(int) -
Method in class org.apache.commons.scaffold.http.ResourceServlet
Set the logging detail level for this servlet.
setMap(Map) -
Method in interface org.apache.commons.scaffold.util.Mapped
Set this object's public properties via a Map.
setMarked(Short) -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
Set the marked status.
setMessage(String) -
Method in class org.apache.commons.scaffold.sql.ConnectionAdaptor
Set a message for an exception if pool returns null.
setMessages(List) -
Method in class org.apache.commons.scaffold.util.ProcessResultBase
Set a new list of messages.
setModified(Timestamp) -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
Set the edited timestamp.
setName(String) -
Method in class org.apache.commons.scaffold.util.ProcessResultBase
Set the attribute name for this result object.
setName(String) -
Method in interface org.apache.commons.scaffold.util.ProcessResult
Set the attribute name for this result object.
setNext(int) -
Method in class org.apache.commons.scaffold.util.Scroller
Set next.
setParameters(Object[]) -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
Set the array of parameters required by the insert and update commands for this object.
setParameters(Object[]) -
Method in interface org.apache.commons.scaffold.util.StorageBean
[:TODO: Javadoc]
setPrefix(String) -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
Set a unique identifier for this StorageBean's commands.
setPrefix(String) -
Method in interface org.apache.commons.scaffold.util.StorageBean
[:TODO: Javadoc]
setPrev(int) -
Method in class org.apache.commons.scaffold.util.Scroller
Set prev.
setPrimaryKey(Object) -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
 
setPrimaryKey(Object) -
Method in interface org.apache.commons.scaffold.util.Storable
Set this object's primary key.
setProperties(Object, Map) -
Static method in class org.apache.commons.scaffold.sql.ResultSetUtils
Populate the JavaBean properties of the specified bean, based on the specified name/value pairs.
setProperties(Properties) -
Method in class org.apache.commons.scaffold.http.ResourceServlet
Set the default properties object.
setRemoteAddr(String) -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
Set the networkNode using a String in the format usually given by the REMOTE_ADDR CGI variable, or ServletRequest.getRemoteAddr().
setRemoteNode(Integer) -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
Set the network address.
setRemoteServer(Object) -
Method in class org.apache.commons.scaffold.util.ProcessBeanBase
 
setRemoteServer(Object) -
Method in interface org.apache.commons.scaffold.util.ProcessBean
Set the remote server
setResult(List) -
Method in class org.apache.commons.scaffold.util.ResultListBase
 
setResult(List) -
Method in interface org.apache.commons.scaffold.util.ResultList
Set our result
setResult(Object) -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
 
setResult(Object) -
Method in interface org.apache.commons.scaffold.util.Storable
Cache the result object of an operation.
setResultCode(int) -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
 
setResultCode(int) -
Method in interface org.apache.commons.scaffold.util.Storable
Set a result code for an operation.
setScope(String) -
Method in class org.apache.commons.scaffold.util.ProcessResultBase
Set the scope under which to store this result object.
setScope(String) -
Method in interface org.apache.commons.scaffold.util.ProcessResult
Set the scope under which to store this result object.
setScroller(Scroller) -
Method in class org.apache.commons.scaffold.model.ModelResultBase
Deprecated.  
setScroller(Scroller) -
Method in interface org.apache.commons.scaffold.model.ModelResult
Deprecated. Set our scroller.
setScroller(Scroller) -
Method in class org.apache.commons.scaffold.util.ResultListBase
 
setScroller(Scroller) -
Method in class org.apache.commons.scaffold.util.ProcessResultBase
 
setScroller(Scroller) -
Method in interface org.apache.commons.scaffold.util.ResultList
Set our scroller.
setScrollFrom(int) -
Method in class org.apache.commons.scaffold.util.ProcessBeanBase
 
setScrollFrom(int) -
Method in interface org.apache.commons.scaffold.util.ProcessBean
Set the scrollFrom
setServlet(HttpServlet) -
Method in class org.apache.commons.scaffold.sql.ServletAdaptor
Set a reference to a servlet in the application to allow access to the servlet context.
setSingleForm(boolean) -
Method in class org.apache.commons.scaffold.util.ProcessResultBase
Set the single-form state: list of 0 or more records=FALSE, exactly one record=TRUE.
setSingleForm(boolean) -
Method in interface org.apache.commons.scaffold.util.ProcessResult
Set the single-form state: list of 0 or more records=FALSE, exactly one record=TRUE.
setThru(int) -
Method in class org.apache.commons.scaffold.util.Scroller
Set thru.
SetUp - class org.apache.commons.scaffold.http.SetUp.Load a connection adaptor and initialize default command store for use with StorageBeans.SetUp() -
Constructor for class org.apache.commons.scaffold.http.SetUp
 
setupDataSource(DataSource) -
Method in class org.apache.commons.scaffold.sql.MockAdaptor
Set internal datasource field.
setValue(Object, Object) -
Method in interface org.apache.commons.scaffold.util.Mapped
Associates the specified value with the specified key in the property map for this object -- the equivalent of getMap().put(key,value).
SHORT -
Static variable in class org.apache.commons.scaffold.text.ConvertUtils
Short style for dates and times.
SHORT_ONE -
Static variable in class org.apache.commons.scaffold.text.ConvertUtils
A Short 1.
SHORT_ZERO -
Static variable in class org.apache.commons.scaffold.text.ConvertUtils
A Short 0.
singleForm -
Variable in class org.apache.commons.scaffold.util.ProcessResultBase
Field to store single-form state [false].
size() -
Method in class org.apache.commons.scaffold.model.ModelResultBase
Deprecated.  
size() -
Method in interface org.apache.commons.scaffold.model.ModelResult
Deprecated. Return the number of elements on the List.
size() -
Method in class org.apache.commons.scaffold.util.ResultListBase
 
size() -
Method in interface org.apache.commons.scaffold.util.ResultList
Return the number of elements on the List.
SocketUtil - class org.apache.commons.scaffold.http.SocketUtil.A shorthand way to create BufferedReaders and PrintWriters associated with a Socket.SocketUtil() -
Constructor for class org.apache.commons.scaffold.http.SocketUtil
 
SPACE -
Static variable in class org.apache.commons.scaffold.lang.Log
Partial string for assembling a message.
SPACE -
Static variable in class org.apache.commons.scaffold.text.ConvertUtils
Space character.
StatementUtils - class org.apache.commons.scaffold.sql.StatementUtils.General purpose SQL Statements.StatementUtils() -
Constructor for class org.apache.commons.scaffold.sql.StatementUtils
 
Storable - interface org.apache.commons.scaffold.util.Storable.Simple interface to describe public methods on a data access object.StorageBean - interface org.apache.commons.scaffold.util.StorageBean.Describes an implementation of standard Store, Retrieve, and Delete operations using the command pattern.StorageBeanBase - class org.apache.commons.scaffold.sql.StorageBeanBase.Implements StorageBean interface using StatementUtils and ResultSetUtils in this package.StorageBeanBase() -
Constructor for class org.apache.commons.scaffold.sql.StorageBeanBase
 
STORE_EXCEPTION -
Static variable in class org.apache.commons.scaffold.lang.Tokens
Default message for throwing exception (en).
store() -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
 
store() -
Method in interface org.apache.commons.scaffold.util.Storable
Commit record to storage.
store(boolean, String, String, Object[]) -
Static method in class org.apache.commons.scaffold.sql.AccessBase
Deprecated. Commit record to storage.
store(Object) -
Method in class org.apache.commons.scaffold.sql.StorageBeanBase
Commit record to storage.
store(Object) -
Method in interface org.apache.commons.scaffold.util.StorageBean
Commit this object to storage.
STRING_10 -
Static variable in class org.apache.commons.scaffold.lang.TestData
Medium, 10-character strings, 0..2.
STRING_20 -
Static variable in class org.apache.commons.scaffold.lang.TestData
Long, 20-character strings, 0..2.
STRING_5 -
Static variable in class org.apache.commons.scaffold.lang.TestData
Short, 5-character strings, 0..2.
STRING_EMPTY -
Static variable in class org.apache.commons.scaffold.text.ConvertUtils
An empty string.
STRING_ONE -
Static variable in class org.apache.commons.scaffold.text.ConvertUtils
A String 1.
STRING_SPACE -
Static variable in class org.apache.commons.scaffold.text.ConvertUtils
An single-space string.
STRING_ZERO -
Static variable in class org.apache.commons.scaffold.text.ConvertUtils
A String 0.
stripLn(String) -
Static method in class org.apache.commons.scaffold.text.ConvertUtils
Replace line returns with spaces.
SUCCESS -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 



T

TABLE -
Static variable in class org.apache.commons.scaffold.sql.StorageBeanBase
[:TODO: Javadoc]
TestData - class org.apache.commons.scaffold.lang.TestData.Statics for use in test classes.TestData() -
Constructor for class org.apache.commons.scaffold.lang.TestData
 
TEXT_PLAIN -
Static variable in class org.apache.commons.scaffold.lang.Tokens
Plain text MIME type.
thru -
Variable in class org.apache.commons.scaffold.util.Scroller
The ending point for the current query [1].
toArray() -
Method in class org.apache.commons.scaffold.util.ResultListBase
 
toArray() -
Method in interface org.apache.commons.scaffold.util.ResultList
Returns an array containing all of the elements in this collection.
toArray(Object[]) -
Method in class org.apache.commons.scaffold.util.ResultListBase
 
toArray(Object[]) -
Method in interface org.apache.commons.scaffold.util.ResultList
Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.
toDate(String) -
Static method in class org.apache.commons.scaffold.text.ConvertUtils
Return Date value using a String.
toEscape(Date) -
Static method in class org.apache.commons.scaffold.text.ConvertUtils
Return String value representing Date.
TOKEN -
Static variable in interface org.apache.commons.scaffold.model.ModelResult
Deprecated. A standard token to identify this object.
TOKEN_PREFIX -
Static variable in class org.apache.commons.scaffold.text.Merge
The token markers for replacement variables, i.e.
TOKEN_PREFIX_LEN -
Static variable in class org.apache.commons.scaffold.text.Merge
 
TOKEN_SUFFIX -
Static variable in class org.apache.commons.scaffold.text.Merge
 
TOKEN_SUFFIX_LEN -
Static variable in class org.apache.commons.scaffold.text.Merge
 
Tokens - class org.apache.commons.scaffold.lang.Tokens.Language and programming tokens.TOKENS_PARSING -
Static variable in class org.apache.commons.scaffold.lang.Log
Parsing tokens.
Tokens() -
Constructor for class org.apache.commons.scaffold.lang.Tokens
 
toString() -
Method in class org.apache.commons.scaffold.util.LabelValueBean
Return a string representation of this object.
toString(Date) -
Static method in class org.apache.commons.scaffold.text.ConvertUtils
Return String value representing Date.
toString(Timestamp) -
Static method in class org.apache.commons.scaffold.text.ConvertUtils
Return String value representing Timestamp.
toTimestamp(String) -
Static method in class org.apache.commons.scaffold.text.ConvertUtils
Return Timestamp value using a String.
toUpperOrNull(String) -
Static method in class org.apache.commons.scaffold.text.ConvertUtils
Returns null or a trimmed uppercase string.



U

UNIT_SEPARATOR -
Static variable in class org.apache.commons.scaffold.text.ConvertUtils
Unit separator character.
UPDATE -
Static variable in class org.apache.commons.scaffold.sql.StorageBeanBase
[:TODO: Javadoc]
UPDATE_EXCEPTION -
Static variable in class org.apache.commons.scaffold.lang.Tokens
Default message for throwing exception (en).
USER_PROFILE_KEY -
Static variable in interface org.apache.commons.scaffold.util.ProcessBean
The session attribute key for our user profile bean ["userProfile"].



V

value -
Variable in class org.apache.commons.scaffold.util.LabelValueBean
The value to be returned to the server.
VERBOSE -
Static variable in class org.apache.commons.scaffold.lang.Log
A milestone event that system administrators might find interesting, like a user logging in.
VERTICAL_TABULATION -
Static variable in class org.apache.commons.scaffold.text.ConvertUtils
Vertical tab character.



W

WELCOME -
Static variable in class org.apache.commons.scaffold.lang.Tokens
 


A B C D E F G H I J K L M N O P R S T U V W






Overview 
Package 
Class 
Tree 
Deprecated 
 Index 
Help 










 PREV 
 NEXT

FRAMES  
 NO FRAMES





Copyright © 2001-2002 - Apache Software Foundation