org.efaps.admin.datamodel.attributevalue.AbstractWithUoM 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.admin.datamodel.attributevalue;

import org.efaps.admin.datamodel.Dimension.UoM;

/**
 * Abstract class used to implement attribute values with unit of measures.
 *
 * @param    class of the VALUE with unit of measure
 * @author The eFaps Team
 * @version $Id: AbstractWithUoM.java 6210 2011-02-18 21:02:56Z [email protected] $
 * @see UoM
 */
public abstract class AbstractWithUoM
{
    /**
     * Link to the unit of measure instance.
     */
    private final UoM uom;

    /**
     * Value itself.
     */
    private final VALUE value;

    /**
     * Initializes this class with {@link #value} and link to the
     * {@link #uom unit of measure}.
     *
     * @param _value    new value
     * @param _uom      link to the unit of measure
     * @see #value
     * @see #uom
     */
    protected AbstractWithUoM(final VALUE _value,
                              final UoM _uom)
    {
        this.value = _value;
        this.uom = _uom;
    }

    /**
     * Returns the {@link #uom unit of measure} instance.
     *
     * @return unit of measure instance
     * @see #uom
     */
    public UoM getUoM()
    {
        return this.uom;
    }

    /**
     * Returns the {@link #value}.
     *
     * @return value
     * @see #value
     */
    public VALUE getValue()
    {
        return this.value;
    }

    /**
     * Converts the {@link #value} in a standardized value depended on defined
     * {@link UoM#getNumerator() numerator} and {@link UoM#getDenominator() denominator}.
     *
     * @return standardized value
     * @see #value
     * @see UoM#getBaseDouble(Double)
     */
    public Double getBaseDouble()
    {
        return (this.value == null) || (this.uom == null)
               ? null
               : this.uom.getBaseDouble(this.value.doubleValue());
    }
}