org.efaps.admin.ui.AbstractCollection 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 - 2012 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: 7483 $
* Last Changed: $Date: 2012-05-11 11:57:38 -0500 (Fri, 11 May 2012) $
* Last Changed By: $Author: [email protected] $
*/
package org.efaps.admin.ui;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;
import org.efaps.admin.datamodel.Type;
import org.efaps.admin.ui.field.Field;
import org.efaps.admin.ui.field.FieldChart;
import org.efaps.admin.ui.field.FieldClassification;
import org.efaps.admin.ui.field.FieldCommand;
import org.efaps.admin.ui.field.FieldGroup;
import org.efaps.admin.ui.field.FieldHeading;
import org.efaps.admin.ui.field.FieldPicker;
import org.efaps.admin.ui.field.FieldSet;
import org.efaps.admin.ui.field.FieldTable;
import org.efaps.ci.CIAdminUserInterface;
import org.efaps.db.MultiPrintQuery;
import org.efaps.db.QueryBuilder;
import org.efaps.util.EFapsException;
import org.efaps.util.cache.CacheReloadException;
/**
* @author The eFaps Team
* @version $Id: AbstractCollection.java 7483 2012-05-11 16:57:38Z [email protected] $
*
*/
public abstract class AbstractCollection
extends AbstractUserInterfaceObject
{
/**
* Instance variable for all field expressions.
*
* @see #addFieldExpr
* @see #getFieldExprIndex
* @see #getAllFieldExpr
*/
private final Map allFieldExpr = new HashMap();
/**
* All fields of the collection are stored sorted belonging to the id of the
* field in a tree map.
*
* @see #getFields
* @see #add(Field)
*/
private final Map fields = new TreeMap();
/**
* Map to have the fields belonging to this collection accessible for name.
*/
private final Map fieldName2Field = new TreeMap();
/**
* Instance variable for the length of the field expression list.
*
* @see #allFieldExpr
*/
private int selIndexLen = 1;
/**
* Select string for the statement.
*
* @see #setSelect
* @see #getSelect
*/
private String select = null;
/**
* Constructor passing on to the super constructor.
*
* @param _id id of this collection
* @param _uuid uuid of this collection
* @param _name name of this collection
*/
protected AbstractCollection(final long _id,
final String _uuid,
final String _name)
{
super(_id, _uuid, _name);
}
/**
* Method to add a Field to this Collection.
*
* @param _field Field to add to this collection
*/
public void add(final Field _field)
{
this.fields.put(_field.getId(), _field);
this.fieldName2Field.put(_field.getName(), _field);
if (_field.getReference() != null && _field.getReference().length() > 0) {
final String ref = _field.getReference();
int index;
int end = 0;
while ((index = ref.indexOf("$<", end)) > 0) {
index += 2;
end = ref.indexOf(">", index);
addFieldExpr(ref.substring(index, end));
}
}
_field.setCollectionUUID(getUUID());
}
/**
* Add a field expression to the select statement and the hash table of all
* field expressions. The method returns the index of the field expression.
* If the field expression is already added, the old index is returned, so a
* expression is only added once.
*
* @param _expr field expression to add
* @return index of the field expression
* @see #getFieldExprIndex
* @see #getAllFieldExpr
* @see #allFieldExpr
*/
protected int addFieldExpr(final String _expr)
{
int ret = -1;
if (getAllFieldExpr().containsKey(_expr)) {
ret = getFieldExprIndex(_expr);
} else {
getAllFieldExpr().put(_expr, Integer.valueOf(getSelIndexLen()));
if (getSelect() == null) {
setSelect(_expr);
} else {
setSelect(getSelect() + "," + _expr);
}
ret = getSelIndexLen();
this.selIndexLen++;
}
return ret;
}
/**
* For the parameter _expr the index in the list of all field
* expressions is returned.
*
* @param _expr expression for which the index is searched
* @return index of the field expression
* @see #addFieldExpr
* @see #getAllFieldExpr
* @see #allFieldExpr
*/
public int getFieldExprIndex(final String _expr)
{
int ret = -1;
if (getAllFieldExpr().containsKey(_expr)) {
final Integer ident = getAllFieldExpr().get(_expr);
ret = ident.intValue();
}
return ret;
}
/**
* The instance method reads all needed information for this user interface
* object.
*
* @see #readFromDB4Fields
* @throws CacheReloadException on error
*/
@Override
protected void readFromDB()
throws CacheReloadException
{
super.readFromDB();
readFromDB4Fields();
}
/**
* Read all fields related to this collection object.
*
* @throws CacheReloadException on error
*/
private void readFromDB4Fields()
throws CacheReloadException
{
try {
final QueryBuilder queryBldr = new QueryBuilder(CIAdminUserInterface.Field);
queryBldr.addWhereAttrEqValue(CIAdminUserInterface.Field.Collection, getId());
final MultiPrintQuery multi = queryBldr.getPrint();
multi.addAttribute(CIAdminUserInterface.Field.Type,
CIAdminUserInterface.Field.Name);
multi.executeWithoutAccessCheck();
while (multi.next()) {
final long id = multi.getCurrentInstance().getId();
final String name = multi.getAttribute(CIAdminUserInterface.Field.Name);
final Type type = multi.getAttribute(CIAdminUserInterface.Field.Type);
final Field field;
if (type.getUUID().equals(CIAdminUserInterface.FieldCommand.uuid)) {
field = new FieldCommand(id, null, name);
} else if (type.getUUID().equals(CIAdminUserInterface.FieldHeading.uuid)) {
field = new FieldHeading(id, null, name);
} else if (type.getUUID().equals(CIAdminUserInterface.FieldTable.uuid)) {
field = new FieldTable(id, null, name);
} else if (type.getUUID().equals(CIAdminUserInterface.FieldGroup.uuid)) {
field = new FieldGroup(id, null, name);
} else if (type.getUUID().equals(CIAdminUserInterface.FieldSet.uuid)) {
field = new FieldSet(id, null, name);
} else if (type.getUUID().equals(CIAdminUserInterface.FieldClassification.uuid)) {
field = new FieldClassification(id, null, name);
} else if (type.getUUID().equals(CIAdminUserInterface.FieldPicker.uuid)) {
field = new FieldPicker(id, null, name);
} else if (type.getUUID().equals(CIAdminUserInterface.FieldChart.uuid)) {
field = new FieldChart(id, null, name);
} else {
field = new Field(id, null, name);
}
field.readFromDB();
add(field);
}
} catch (final EFapsException e) {
throw new CacheReloadException("could not read fields for '" + getName() + "'", e);
}
}
/**
* The method takes values of the {@link #fields} and returnes them as
* {@link java.util.ArrayList}.
*
* @return the values of the {@link #fields} map instance as array list
* @see #fields
*/
public List getFields()
{
return new ArrayList(this.fields.values());
}
/**
* @see #allFieldExpr
* @return the hashtable which holds single field expression
*/
private Map getAllFieldExpr()
{
return this.allFieldExpr;
}
/**
* Get the value of the attribute {@link #selIndexLen}.
*
* @return the value of the attribute {@link #selIndexLen}
* @see #selIndexLen
*/
private int getSelIndexLen()
{
return this.selIndexLen;
}
/**
* This is the setter method for instance variable {@link #select}.
*
* @param _select new value for instance variable {@link #select}
* @see #select
* @see #getSelect
*/
protected void setSelect(final String _select)
{
this.select = _select;
}
/**
* Get the value of the {@link #select} clause.
*
* @return the value of the {@link #select} clause
* @see #select
* @see #setSelect
*/
public String getSelect()
{
return this.select;
}
/**
* Method to get the whole map of fields.
*
* @return Map
*/
public Map getFieldsMap()
{
return this.fields;
}
/**
* Method to get a field belonging to this collection by its name.
* @param _fieldName name of the field wanted
* @return Field if found, else null
*/
public Field getField(final String _fieldName)
{
return this.fieldName2Field.get(_fieldName);
}
}