org.efaps.admin.datamodel.attributetype.AbstractType Maven / Gradle / Ivy

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 - 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.datamodel.attributetype;

import java.sql.SQLException;

import org.efaps.admin.datamodel.Attribute;
import org.efaps.admin.datamodel.IAttributeType;
import org.efaps.db.wrapper.AbstractSQLInsertUpdate;
import org.efaps.db.wrapper.SQLInsert;
import org.efaps.db.wrapper.SQLUpdate;
import org.efaps.util.EFapsException;

/**
 * @author The eFaps Team
 * @version $Id: AbstractType.java 7483 2012-05-11 16:57:38Z [email protected] $
 */
public abstract class AbstractType
    implements IAttributeType
{
    /**
     * {@inheritDoc}
     */
    @Override
    public void prepareInsert(final SQLInsert _insert,
                              final Attribute _attribute,
                              final Object... _values)
        throws SQLException
    {
        prepare(_insert, _attribute, _values);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void prepareUpdate(final SQLUpdate _update,
                              final Attribute _attribute,
                              final Object... _values)
        throws SQLException
    {
        prepare(_update, _attribute, _values);
    }

    /**
     *
     * @param _insertUpdate SQL insert / update statement
     * @param _attribute    SQL update statement
     * @param _values       new object value to set; values are localized and
     *                      are coming from the user interface
     * @throws SQLException always, because the method must be overwritten
     */
    protected void prepare(final AbstractSQLInsertUpdate _insertUpdate,
                           final Attribute _attribute,
                           final Object... _values)
        throws SQLException
    {
        throw new SQLException("not implemented for " + this.getClass());
    }

    /**
     * Checks for expected _size of SQL columns for
     * _attribute.
     *
     * @param _attribute    attribute to check
     * @param _size         expected size of SQL columns
     * @throws SQLException if the size of the SQL columns in
     *                      _attribute is not the expected
     *                      _size
     */
    public void checkSQLColumnSize(final Attribute _attribute,
                                   final int _size)
        throws SQLException
    {
        if ((_attribute.getSqlColNames() == null) || _attribute.getSqlColNames().isEmpty())  {
            throw new SQLException("no SQL column for attribute defined");
        }
        if (_attribute.getSqlColNames().size() > _size)  {
            throw new SQLException("more than " + _size + " SQL columns defined (is "
                    + _attribute.getSqlColNames().size() + ")");
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String toString4Where(final Object _value)
        throws EFapsException
    {
        return _value.toString();
    }

}