org.efaps.beans.ValueList 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.beans;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.Set;
import org.efaps.admin.datamodel.Attribute;
import org.efaps.admin.datamodel.ui.FieldValue;
import org.efaps.admin.ui.AbstractUserInterfaceObject.TargetMode;
import org.efaps.db.AbstractPrintQuery;
import org.efaps.db.AbstractQuery;
import org.efaps.db.Instance;
import org.efaps.util.EFapsException;
/**
* This class work together with the generated classes of the kernel
* (org.efpas.beans.valueparser) to get the Values for a String expression
* defined as a DBProperty like: "$< Type> '$< Name>': Details" from the
* eFaps-DataBase. The Values for an expression ("$< Type>") retrieved from the
* eFaps-DataBase will be combined with pure Text ("Details").
*
* @author The eFaps Team
* @version $Id: ValueList.java 6210 2011-02-18 21:02:56Z [email protected] $
*/
public class ValueList
{
/**
* Enum used to differ expression parts from text parts.
*/
public enum TokenType
{
/** Used for token of type expression. */
EXPRESSION,
/** Used for token of type text. */
TEXT
}
/**
* Holds the Expressions used in this ValueList.
*/
private final Set expressions = new HashSet();
/**
* Holds the tokens of this ValueList.
*/
private final ArrayList tokens = new ArrayList();
/**
* Getter method for instance variable {@link #tokens}.
*
* @return value of instance variable {@link #tokens}
*/
public ArrayList getTokens()
{
return this.tokens;
}
/**
* Get the ValueList.
*
* @return String with the Values, which looks like the original
*/
public String getValueList()
{
final StringBuffer buf = new StringBuffer();
for (final Token token : this.tokens) {
switch (token.type) {
case EXPRESSION:
buf.append("$<").append(token.value).append(">");
break;
case TEXT:
buf.append(token.value);
break;
default:
break;
}
}
return buf.toString();
}
/**
* Add an Expression to this ValueList.
*
* @param _expression String with the expression
*/
public void addExpression(final String _expression)
{
this.tokens.add(new Token(ValueList.TokenType.EXPRESSION, _expression));
getExpressions().add(_expression);
}
/**
* Add Text to the Tokens.
*
* @param _text Text to be added
*/
public void addText(final String _text)
{
this.tokens.add(new Token(ValueList.TokenType.TEXT, _text));
}
/**
* This method adds the expressions of this ValueList to the given query.
*
* @param _query AbstractQuery the expressions should be added
* @throws EFapsException on error
* @see {@link #makeString(AbstractQuery)}
* @deprecated will be removed 2.0
*/
@Deprecated
public void makeSelect(final AbstractQuery _query) throws EFapsException
{
for (final String expression : getExpressions()) {
_query.addSelect(expression);
}
}
/**
* This method adds the expressions of this ValueList to the given query.
*
* @param _print PrintQuery the expressions should be added
* @throws EFapsException on error
* @see {@link #makeString(AbstractQuery)}
*/
public void makeSelect(final AbstractPrintQuery _print) throws EFapsException
{
for (final String expression : getExpressions()) {
if (expression.contains("[")) {
_print.addSelect(expression);
} else {
_print.addAttribute(expression);
}
}
}
/**
* This method retrieves the Values from the given AbstractQuery and
* combines them with the Text partes.
*
* @param _callInstance instance on which the query was called
* @param _query AbstractQuery the ValueString should be retrieved
* @param _mode target mode
* @return String with the actuall Value of this ValueList
* @throws Exception on error
* @see {@link #makeSelect(AbstractQuery)}
* @deprecated will be removed 2.0
*/
@Deprecated
public String makeString(final Instance _callInstance,
final AbstractQuery _query,
final TargetMode _mode)
throws Exception
{
final StringBuilder buf = new StringBuilder();
for (final Token token : this.tokens) {
switch (token.type) {
case EXPRESSION:
final Attribute attr = _query.getAttribute(token.value);
final Object value = _query.get(token.value);
buf.append((new FieldValue(null, attr, value, null, _callInstance)).getStringValue(_mode));
break;
case TEXT:
buf.append(token.value);
break;
default:
break;
}
}
return buf.toString();
}
/**
* This method retrieves the Values from the given PrintQuery and
* combines them with the Text partes.
*
* @param _callInstance instance on which the query was called
* @param _print AbstractPrintQuery the ValueString should be retrieved
* @param _mode target mode
* @return String with the actuall Value of this ValueList
* @throws EFapsException on error
* @see {@link #makeSelect(AbstractQuery)}
*
*/
public String makeString(final Instance _callInstance,
final AbstractPrintQuery _print,
final TargetMode _mode)
throws EFapsException
{
final StringBuilder buf = new StringBuilder();
for (final Token token : this.tokens) {
switch (token.type) {
case EXPRESSION:
final Attribute attr;
final Object value;
if (token.value.contains("[")) {
attr = _print.getAttribute4Select(token.value);
value = _print.getSelect(token.value);
} else {
attr = _print.getAttribute4Attribute(token.value);
value = _print.getAttribute(token.value);
}
buf.append((new FieldValue(null, attr, value, null, _callInstance)).getStringValue(_mode));
break;
case TEXT:
buf.append(token.value);
break;
default:
break;
}
}
return buf.toString();
}
/**
* This is the getter method for the instance variable {@link #expressions}.
*
* @return value of instance variable {@link #expressions}
* @see #expressions
*/
public Set getExpressions()
{
return this.expressions;
}
/**
* This class holds the definitions of the ValueList.
*/
public final class Token
{
/**
* This instance variable holds the Type of this token.
*/
private final TokenType type;
/**
* This instance variable holds the value of this token.
*/
private final String value;
/**
* Constructor setting the instance variables.
*
* @param _type TokenType
* @param _value Value for the token
*/
private Token(final TokenType _type,
final String _value)
{
this.type = _type;
this.value = _value;
}
/**
* Getter method for instance variable {@link #type}.
*
* @return value of instance variable {@link #type}
*/
public TokenType getType()
{
return this.type;
}
/**
* Getter method for instance variable {@link #value}.
*
* @return value of instance variable {@link #value}
*/
public String getValue()
{
return this.value;
}
}
}