org.efaps.db.AbstractObjectQuery Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of efaps-kernel Show documentation
Show all versions of efaps-kernel Show documentation
eFaps is a framework used to map objects with or without attached files to
a relational database and optional file systems (only for attaches files). Configurable access control can be provided down to object and attribute level depending on implementation and use case. Depending on requirements, events (like triggers) allow to implement business logic and to separate business logic from user interface.
The framework includes integrations (e.g. webdav, full text search) and a web application as 'simple' configurable user interface. Some best practises, example web application modules (e.g. team work module) support administrators and implementers using this framework.
/*
* Copyright 2003 - 2011 The eFaps Team
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Revision: $Rev: 6210 $
* Last Changed: $Date: 2011-02-18 16:02:56 -0500 (Fri, 18 Feb 2011) $
* Last Changed By: $Author: [email protected] $
*/
package org.efaps.db;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.efaps.admin.datamodel.SQLTable;
import org.efaps.admin.datamodel.Type;
import org.efaps.db.search.QAnd;
import org.efaps.db.search.QAttribute;
import org.efaps.db.search.compare.QEqual;
import org.efaps.db.search.section.QLimitSection;
import org.efaps.db.search.section.QOrderBySection;
import org.efaps.db.search.section.QWhereSection;
import org.efaps.db.search.value.QNumberValue;
import org.efaps.util.EFapsException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* TODO comment!
*
* @author The eFaps Team
* @version $Id: AbstractObjectQuery.java 6210 2011-02-18 21:02:56Z [email protected] $
* @param type the query returns
*/
public abstract class AbstractObjectQuery
{
/**
* Logging instance used in this class.
*/
protected static final Logger LOG = LoggerFactory.getLogger(AbstractObjectQuery.class);
/**
* Must this query be executed company depended.
* (if the type is company dependend)
*/
private boolean companyDepended = true;
/**
* Base type this query is searching on.
*/
private final Type baseType;
/**
* The where criteria for this search.
*/
private QWhereSection where;
/**
* Order by clause for this query.
*/
private QOrderBySection orderBy;
/**
* Limit for this Query.
*/
private QLimitSection limit;
/**
* Should the child types be also be included in this search?
*/
private boolean includeChildTypes = true;
/**
* Map to store the table to index relation.
*/
private final Map sqlTable2Index = new HashMap();
/**
* List contains the values returned from the query.
*/
private final List values = new ArrayList();
/**
* Iterator for the instances.
*/
private Iterator iter;
/**
* Variable holds the current instance.
*/
private T current;
/**
* Constructor setting the type.
* @param _type TYpe the query is based on
*/
public AbstractObjectQuery(final Type _type)
{
this.baseType = _type;
}
/**
* @return List of objects
* @throws EFapsException on error
*/
public abstract List execute()
throws EFapsException;
/**
* @return List of objects
* @throws EFapsException on error
*/
public abstract List executeWithoutAccessCheck()
throws EFapsException;
/**
* Getter method for the instance variable {@link #companyDepended}.
*
* @return value of instance variable {@link #companyDepended}
*/
public boolean isCompanyDepended()
{
return this.companyDepended;
}
/**
* Setter method for instance variable {@link #companyDepended}.
*
* @param _companyDepended value for instance variable {@link #companyDepended}
* @return this
*/
public AbstractObjectQuery setCompanyDepended(final boolean _companyDepended)
{
this.companyDepended = _companyDepended;
return this;
}
/**
* Getter method for the instance variable {@link #includeChildTypes}.
*
* @return value of instance variable {@link #includeChildTypes}
*/
public boolean isIncludeChildTypes()
{
return this.includeChildTypes;
}
/**
* Setter method for instance variable {@link #includeChildTypes}.
*
* @param _includeChildTypes value for instance variable {@link #includeChildTypes}
* @return this
*/
public AbstractObjectQuery setIncludeChildTypes(final boolean _includeChildTypes)
{
this.includeChildTypes = _includeChildTypes;
return this;
}
/**
* Getter method for the instance variable {@link #baseType}.
*
* @return value of instance variable {@link #baseType}
*/
public Type getBaseType()
{
return this.baseType;
}
/**
* Getter method for the instance variable {@link #sqlTable2Index}.
*
* @return value of instance variable {@link #sqlTable2Index}
*/
public Map getSqlTable2Index()
{
return this.sqlTable2Index;
}
/**
* Get the index for a SQLTable if the table is not existing the table is
* added and a new index given.
*
* @param _sqlTable SQLTable the index is wanted for
* @return index of the SQLTable
*/
public Integer getIndex4SqlTable(final SQLTable _sqlTable)
{
Integer ret;
if (this.sqlTable2Index.containsKey(_sqlTable)) {
ret = this.sqlTable2Index.get(_sqlTable);
} else {
Integer max = 0;
for (final Integer index : this.sqlTable2Index.values()) {
if (index > max) {
max = index;
}
}
ret = max + 1;
this.sqlTable2Index.put(_sqlTable, ret);
}
return ret;
}
/**
* setter method for the instance variable {@link #where}.
* @param _where value for instance variable {@link #where}
* @return this
*/
public AbstractObjectQuery setWhere(final QWhereSection _where)
{
this.where = _where;
return this;
}
/**
* Getter method for the instance variable {@link #where}.
*
* @return value of instance variable {@link #where}
*/
public QWhereSection getWhere()
{
return this.where;
}
/**
* Getter method for the instance variable {@link #orderBy}.
*
* @return value of instance variable {@link #orderBy}
*/
public QOrderBySection getOrderBy()
{
return this.orderBy;
}
/**
* Setter method for instance variable {@link #orderBy}.
*
* @param _orderBy value for instance variable {@link #orderBy}
*/
public void setOrderBy(final QOrderBySection _orderBy)
{
this.orderBy = _orderBy;
}
/**
* Getter method for the instance variable {@link #limit}.
*
* @return value of instance variable {@link #limit}
*/
public QLimitSection getLimit()
{
return this.limit;
}
/**
* Setter method for instance variable {@link #limit}.
*
* @param _limit value for instance variable {@link #limit}
*/
public void setLimit(final int _limit)
{
this.limit = new QLimitSection(_limit);
}
/**
* Setter method for instance variable {@link #limit}.
*
* @param _limit value for instance variable {@link #limit}
*/
public void setLimit(final QLimitSection _limit)
{
this.limit = _limit;
}
/**
* Move the current instance to the next instance in the list.
* @return true if the instance was set to the next value, else false
*/
public boolean next()
{
if (this.iter == null) {
this.iter = new ArrayList(this.values).iterator();
}
final boolean ret = this.iter.hasNext();
if (ret) {
this.current = this.iter.next();
}
return ret;
}
/**
* Get the current instance.
* @return value of instance variable {@link #current}
*/
public T getCurrentValue()
{
return this.current;
}
/**
* Getter method for the instance variable {@link #instances}.
*
* @return value of instance variable {@link #instances}
*/
public List getValues()
{
return this.values;
}
/**
* Prepare the Query for execution.
* @throws EFapsException on error
*/
protected void prepareQuery()
throws EFapsException
{
this.sqlTable2Index.put(this.baseType.getMainTable(), 0);
if (this.baseType.getMainTable().getSqlColType() != null) {
final QEqual eqPart = new QEqual(new QAttribute(this.baseType.getTypeAttribute()),
new QNumberValue(this.baseType.getId()));
if (this.includeChildTypes && !this.baseType.getChildTypes().isEmpty()) {
for (final Type type : this.baseType.getChildTypes()) {
eqPart.addValue(new QNumberValue(type.getId()));
}
}
if (this.where == null) {
this.where = new QWhereSection(eqPart);
} else {
this.where.setPart(new QAnd(this.where.getPart(), eqPart));
}
}
if (this.companyDepended && this.baseType.isCompanyDepended()) {
if (Context.getThreadContext().getCompany() == null) {
throw new EFapsException(InstanceQuery.class, "noCompany");
}
final QEqual eqPart = new QEqual(new QAttribute(this.baseType.getCompanyAttribute()),
new QNumberValue(Context.getThreadContext().getCompany().getId()));
if (this.where == null) {
this.where = new QWhereSection(eqPart);
} else {
this.where.setPart(new QAnd(this.where.getPart(), eqPart));
}
}
if (this.where != null) {
this.where.prepare(this);
}
if (this.orderBy != null) {
this.orderBy.prepare(this);
}
if (this.limit != null) {
this.limit.prepare(this);
}
}
}