org.efaps.admin.datamodel.attributetype.OIDType 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 java.util.ArrayList;
import java.util.List;

import org.efaps.admin.datamodel.Attribute;
import org.efaps.db.query.CachedResult;
import org.efaps.db.wrapper.SQLUpdate;

/**
 * @author The eFaps Team
 * @version $Id: OIDType.java 7483 2012-05-11 16:57:38Z [email protected] $
 */
public class OIDType
    extends StringType
{

    /**
     * An update of an OID is not allowed and therefore a {@link SQLException}
     * is always thrown.
     *
     * @param _update       update SQL statement; ignored
     * @param _attribute    related eFaps attribute; ignored because update is
     *                      not allowed for the eFaps object id
     * @param _values       ignored
     * @throws SQLException always because update is not allowed
     */
    @Override
    public void prepareUpdate(final SQLUpdate _update,
                              final Attribute _attribute,
                              final Object... _values)
        throws SQLException
    {
        throw new SQLException("Update value for OID not allowed!!!");
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Object readValue(final Attribute _attribute,
                            final CachedResult _rs,
                            final List _indexes)
    {
        final StringBuilder ret = new StringBuilder();
        if (_attribute.getSqlColNames().size() > 1) {
            final long typeId = _rs.getLong(_indexes.get(0).intValue());
            final long id = _rs.getLong(_indexes.get(1).intValue());
            ret.append(typeId).append(".").append(id);
        } else {
            final long id = _rs.getLong(_indexes.get(0).intValue());
            ret.append(_attribute.getParent().getId()).append(".").append(id);
        }
        return ret.toString();
    }

    /**
     * The oid (object id) is the type id, than a point and the id itself. If in
     * the attribute the attribute has no defined type id SQL column name, the
     * type from the attribute is used (this means, the type itself is not
     * derived and has no childs).
     *
     * @param _attribute    related attribute which is read
     * @param _objectList   list of objects from the eFaps Database
     * @return Object as needed for eFaps
     */
    @Override
    public Object readValue(final Attribute _attribute,
                            final List