org.estatio.dom.index.IndexBase.java Source code

Introduction

Here is the source code for org.estatio.dom.index.IndexBase.java

Source

/*
 *
 *  Copyright 2012-2014 Eurocommercial Properties NV
 *
 *
 *  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.
 */
package org.estatio.dom.index;

import java.math.BigDecimal;
import java.util.SortedSet;
import java.util.TreeSet;
import javax.jdo.annotations.IdGeneratorStrategy;
import javax.jdo.annotations.IdentityType;
import javax.jdo.annotations.VersionStrategy;
import org.isisaddons.module.security.dom.tenancy.ApplicationTenancy;
import org.joda.time.LocalDate;
import org.apache.isis.applib.annotation.CollectionLayout;
import org.apache.isis.applib.annotation.DomainObject;
import org.apache.isis.applib.annotation.Editing;
import org.apache.isis.applib.annotation.Optionality;
import org.apache.isis.applib.annotation.Programmatic;
import org.apache.isis.applib.annotation.PropertyLayout;
import org.apache.isis.applib.annotation.Property;
import org.apache.isis.applib.annotation.RenderType;
import org.apache.isis.applib.annotation.Title;
import org.estatio.dom.Chained;
import org.estatio.dom.EstatioDomainObject;
import org.estatio.dom.WithStartDate;
import org.estatio.dom.apptenancy.WithApplicationTenancyCountry;
import org.estatio.dom.utils.MathUtils;

/**
 * Represents the periodic rebasing of an {@link Index}, and
 * {@link #getValues() holds} the {@link IndexValue value}s until the
 * {@link #getNext() next} rebasing.
 * 
 * @see Index
 */
@javax.jdo.annotations.PersistenceCapable(identityType = IdentityType.DATASTORE)
@javax.jdo.annotations.DatastoreIdentity(strategy = IdGeneratorStrategy.NATIVE, column = "id")
@javax.jdo.annotations.Version(strategy = VersionStrategy.VERSION_NUMBER, column = "version")
@javax.jdo.annotations.Queries({
        @javax.jdo.annotations.Query(name = "findByIndexAndDate", language = "JDOQL", value = "SELECT "
                + "FROM org.estatio.dom.index.IndexBase " + "WHERE index == :index " + "&& startDate <= :date "
                + "ORDER BY startDate DESC ") })
@DomainObject(editing = Editing.DISABLED)
public class IndexBase extends EstatioDomainObject<IndexBase>
        implements WithStartDate, Chained<IndexBase>, WithApplicationTenancyCountry {

    public static final int FACTOR_SCALE = 4;

    public IndexBase() {
        super("index, startDate desc");
    }

    // //////////////////////////////////////

    @PropertyLayout(named = "Application Level", describedAs = "Determines those users for whom this object is available to view and/or modify.")
    public ApplicationTenancy getApplicationTenancy() {
        return getIndex().getApplicationTenancy();
    }

    // //////////////////////////////////////

    private Index index;

    @javax.jdo.annotations.Column(name = "indexId", allowsNull = "false")
    @Title(sequence = "1", append = ", ")
    public Index getIndex() {
        return index;
    }

    public void setIndex(final Index index) {
        this.index = index;
    }

    // //////////////////////////////////////

    @javax.jdo.annotations.Persistent
    private LocalDate startDate;

    @javax.jdo.annotations.Column(allowsNull = "false")
    @Title(sequence = "2")
    public LocalDate getStartDate() {
        return startDate;
    }

    public void setStartDate(final LocalDate startDate) {
        this.startDate = startDate;
    }

    public void modifyStartDate(final LocalDate startDate) {
        final LocalDate currentStartDate = getStartDate();
        if (startDate == null || startDate.equals(currentStartDate)) {
            return;
        }
        setStartDate(startDate);
    }

    public void clearStartDate() {
        LocalDate currentStartDate = getStartDate();
        if (currentStartDate == null) {
            return;
        }
        setStartDate(null);
    }

    // //////////////////////////////////////

    @javax.jdo.annotations.Persistent
    @javax.jdo.annotations.Column(scale = FACTOR_SCALE)
    private BigDecimal factor;

    @Property(optionality = Optionality.OPTIONAL)
    public BigDecimal getFactor() {
        return factor;
    }

    public void setFactor(final BigDecimal factor) {
        this.factor = factor;
    }

    public String validateFactor(final BigDecimal factor) {
        if (getPrevious() == null) {
            return null;
        }
        return MathUtils.isZeroOrNull(factor) ? "Factor is mandatory when there is a previous base" : null;
    }

    // //////////////////////////////////////

    @javax.jdo.annotations.Column(name = "previousIndexBaseId")
    @javax.jdo.annotations.Persistent(mappedBy = "next")
    private IndexBase previous;

    /**
     * @see #getNext()
     */
    @Property(optionality = Optionality.OPTIONAL)
    public IndexBase getPrevious() {
        return previous;
    }

    public void setPrevious(final IndexBase previous) {
        this.previous = previous;
    }

    public void modifyPrevious(final IndexBase previous) {
        setPrevious(previous);
        if (previous != null) {
            previous.setNext(this);
        }
    }

    // //////////////////////////////////////

    @javax.jdo.annotations.Column(name = "nextIndexBaseId")
    private IndexBase next;

    /**
     * @see #getPrevious()
     */
    @Property(optionality = Optionality.OPTIONAL)
    public IndexBase getNext() {
        return next;
    }

    public void setNext(final IndexBase nextBase) {
        this.next = nextBase;
    }

    // //////////////////////////////////////

    @javax.jdo.annotations.Persistent(mappedBy = "indexBase")
    private SortedSet<IndexValue> values = new TreeSet<IndexValue>();

    @CollectionLayout(render = RenderType.EAGERLY)
    public SortedSet<IndexValue> getValues() {
        return values;
    }

    public void setValues(final SortedSet<IndexValue> values) {
        this.values = values;
    }

    public void addToValues(final IndexValue value) {
        if (value == null || getValues().contains(value)) {
            return;
        }
        value.clearIndexBase();
        value.setIndexBase(this);
        getValues().add(value);
    }

    public void removeFromValues(final IndexValue value) {
        // check for no-op
        if (value == null || !getValues().contains(value)) {
            return;
        }
        value.setIndexBase(null);
        getValues().remove(value);
    }

    // //////////////////////////////////////

    @Programmatic
    public BigDecimal factorForDate(final LocalDate date) {
        return date.isBefore(getStartDate()) ? getFactor().multiply(getPrevious().factorForDate(date))
                : BigDecimal.ONE;
    }

}