org.efaps.db.print.Phrase 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

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.

There is a newer version: 3.2.0

Show newest version

/*
 * 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.print;

import java.util.HashMap;
import java.util.Map;

import org.efaps.admin.datamodel.ui.FieldValue;
import org.efaps.admin.ui.AbstractUserInterfaceObject.TargetMode;
import org.efaps.beans.ValueList;
import org.efaps.beans.ValueList.Token;
import org.efaps.db.Instance;
import org.efaps.util.EFapsException;

/**
 * Class is used as a wraper for a series of OneSelects as part of one
 * phrase.
 *
 * @author The eFaps Team
 * @version $Id: Phrase.java 6210 2011-02-18 21:02:56Z [email protected] $
 */
public class Phrase
{
    /**
     * Key for this Phrase.
     */
    private final String key;

    /**
     * Phrase statement for this Phrase.
     */
    private final String phraseStmt;

    /**
     * Mapping of Select statements to OneSelect.
     */
    private final Map selectStmt2OneSelect = new HashMap();

    /**
     * ValueList to access the parser.
     */
    private final ValueList valueList;

    /**
     * @param _key          Key for this Phrase
     * @param _phraseStmt   Phrase statement for this Phrase
     * @param _valueList    ValueList to access the parser.
     */
    public Phrase(final String _key, final String _phraseStmt, final ValueList _valueList)
    {
        this.key = _key;
        this.phraseStmt = _phraseStmt;
        this.valueList = _valueList;
    }

    /**
     * Method to get the parsed value for this phrase.
     * @param _instance Instance the phrase is build on
     * @return  parsed value
     * @throws EFapsException on error
     */
    public String getPhraseValue(final Instance _instance)
        throws EFapsException
    {
        final StringBuilder buf = new StringBuilder();

        for (final Token token : this.valueList.getTokens()) {
            switch (token.getType()) {
                case EXPRESSION:
                    final OneSelect oneselect = this.selectStmt2OneSelect.get(token.getValue());
                    final Object value = oneselect.getObject();
                    if (oneselect.getAttribute() != null) {
                        buf.append((new FieldValue(null, oneselect.getAttribute(), value, _instance, null))
                                    .getStringValue(TargetMode.VIEW));
                    } else if (value != null) {
                        buf.append(value);
                    }
                    break;
                case TEXT:
                    buf.append(token.getValue());
                    break;
                default:
                    break;
            }
        }
        return buf.toString();
    }

    /**
     * Add a oneselect to this Phrase.
     * @param _oneselect    OneSelect to add
     */
    public void addSelect(final OneSelect _oneselect)
    {
        this.selectStmt2OneSelect.put(_oneselect.getSelectStmt(), _oneselect);
    }

    /**
     * Getter method for instance variable {@link #key}.
     *
     * @return value of instance variable {@link #key}
     */
    public String getKey()
    {
        return this.key;
    }

    /**
     * Getter method for instance variable {@link #phraseStmt}.
     *
     * @return value of instance variable {@link #phraseStmt}
     */
    public String getPhraseStmt()
    {
        return this.phraseStmt;
    }
}