husted 2002/10/28 11:46:22
Added: scaffold/src/java/org/apache/commons/scaffold/sql
ScrollerBeanBase.java
Log:
+ ScrollerBeanBase: Initial version.
Revision Changes Path
1.1
jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/sql/ScrollerBeanBase.java
Index: ScrollerBeanBase.java
===================================================================
package org.apache.commons.scaffold.sql;
import java.util.Collection;
import org.apache.commons.scaffold.lang.Tokens;
import org.apache.commons.scaffold.lang.ParameterException;
import org.apache.commons.scaffold.lang.ResourceException;
import org.apache.commons.scaffold.util.ProcessResult;
import org.apache.commons.scaffold.util.ProcessResultBase;
import org.apache.commons.scaffold.util.ResultList;
import org.apache.commons.scaffold.util.ResultListBase;
import org.apache.commons.scaffold.util.Scroller;
import org.apache.commons.scaffold.util.ScrollerBean;
/**
* Base class for scrolling searches.
*
* @author Ted Husted
* @version $Revision: 1.1 $ $Date: 2002/10/28 19:46:22 $
*/
public class ScrollerBeanBase extends StorageBeanBase implements ScrollerBean {
/**
* The entry (or page) from which to scroll [1].
*/
public int scrollFrom = 1;
// See interface for Javadoc
public int getScrollFrom() {
return scrollFrom;
}
// See interface for Javadoc
public void setScrollFrom(int scrollFrom) {
this.scrollFrom = scrollFrom;
}
// See interface for Javadoc
public int getScrollRows() {
return Scroller.SCROLL_ROWS;
}
// See interface for Javadoc
public int getEntryCount() throws ResourceException {
return countLike(getCountKey(),getSearchKey());
}
// See interface for Javadoc
public Scroller getScroller(int entries) throws ResourceException {
Scroller scroller = new Scroller();
scroller.calculate(
entries,
getScrollFrom(),
getEntryCount(),
getScrollRows()
);
if (isParameter()) {
java.util.Map map = new java.util.HashMap();
map.put(getSearchProperty(),getSearchKey());
scroller.setParameters(map);
}
return scroller;
}
// See interface for Javadoc
public String getCommandKey() {
return null;
}
// See interface for Javadoc
public Object[] getParameters(Object parameter)
throws ResourceException {
Object[] parameters = new Object[3];
parameters[0] = parameter;
parameters[1] = new Integer(getScrollFrom());
parameters[2] = new Integer(getScrollRows());
return parameters;
}
// See interface for Javadoc
public Collection getResult(Object target, Object parameter)
throws ResourceException {
return findCollectionLike(
target,
getCommandKey(),
getParameters(parameter)
);
}
// See interface for Javadoc
public String getSearchProperty() {
return null;
}
// See interface for Javadoc
public String getSearchKey() {
return null;
}
// See interface for Javadoc
public String getCountKey() {
return null;
}
// See interface for Javadoc
public boolean isParameter() {
return false;
}
// See interface for Javadoc
public boolean isFailsOnEmpty () {
return false;
}
// See interface for Javadoc
public String getTokenEmptyMessage() {
return Tokens.DATA_ACCESS_EMPTY;
}
// See interface for Javadoc
public String getTokenEmptyDispatch() {
return Tokens.FAILURE;
}
/**
* Invoke business logic; return ProcessResult.
*/
public Object scrollerSearch() throws Exception {
Object key = null;
if (isParameter()) {
key = getSearchKey();
if (null==key) {
throw new ParameterException();
}
}
ResultList list = new ResultListBase (getResult(this,key));
Scroller scroller = getScroller(list.size());
list.setScroller(scroller);
ProcessResult result = new ProcessResultBase(list);
if (isParameter())
list.setLegend(getSearchProperty(),key.toString());
else
list.setLegend(getSearchProperty());
if (isFailsOnEmpty() && list.isEmpty()) {
result.addMessage(getTokenEmptyMessage());
result.setDispatch(getTokenEmptyDispatch());
}
return result;
} // end scrollerSearch
} // end ScrollerBeanBase
/*
*
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2002 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
*/
--
To unsubscribe, e-mail: <mailto:commons-dev-unsubscribe@;jakarta.apache.org>
For additional commands, e-mail: <mailto:commons-dev-help@;jakarta.apache.org>
