AbstractFixture.java

/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you 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.apache.isis.applib.fixtures;

import java.util.Collections;
import java.util.List;

import com.google.common.base.Predicate;
import com.google.common.collect.Lists;

import org.apache.isis.applib.annotation.Programmatic;
import org.apache.isis.applib.fixturescripts.FixtureScript;

/**
 * Convenience class for creating fixtures.
 * 
 * <p>
 * Most subclasses will simply override {@link #install()} to setup objects. In
 * addition though fixtures may also:
 * <ul>
 * <li>change the date/time within the course of fixture installation, using
 * {@link #setDate(int, int, int)} and {@link #setTime(int, int)}.
 * <li>create composite fixtures using {@link #addFixture(Object)}.
 * <li>search for existing objects using
 * {@link #firstMatch(Class, Predicate)} or
 * {@link #uniqueMatch(Class, Predicate)} (and various
 * overloads thereof).
 * </ul>
 * 
 * <p>
 * This class has been designed so that it can also be used as a regular
 * domain object.  This may be useful to allow users to setup demo data in a
 * running application.
 *  
 * <p>
 * To automatically logon for the demo/test, use {@link LogonFixture}.
 *
 * @deprecated - use {@link FixtureScript} instead.
 */
@Deprecated
public abstract class AbstractFixture extends BaseFixture implements CompositeFixture {

    private final List<Object> fixtures = Lists.newArrayList();


    /**
     * Assumed to be {@link FixtureType#DOMAIN_OBJECTS data} fixture.
     */
    public AbstractFixture() {
        this(FixtureType.DOMAIN_OBJECTS);
    }

    public AbstractFixture(final FixtureType fixtureType) {
        super(fixtureType);
    }

    // ///////////////////////////////////////////////////////////////
    // install() hook (for non-composites)
    // ///////////////////////////////////////////////////////////////

    /**
     * Most subclasses will override this method, but composite fixtures should
     * instead call {@link #addFixture(Object)} in their constructor.
     * 
     * <p>
     * The iteration over the child fixtures is then performed by the
     * <tt>FixturesInstallerDelegate</tt> (or equivalent).
     * 
     * <p>
     * A slightly strange implementation?  Oh well, it works.
     */
    @Override
    public void install() {
    }



    // CompositeFixture impl

    /**
     * Allows the fixture to act as a composite (call within constructor).
     *
     * @deprecated - use {@link FixtureScript} instead.
     */
    @Deprecated
    protected void addFixture(final Object fixture) {
        fixtures.add(fixture);
    }

    /**
     * Returns an array of any fixtures that have been
     * {@link #addFixture(Object) added}.
     *
     * @deprecated - use {@link FixtureScript} instead.
     */
    @Deprecated
    @Programmatic // to allow this class to be used as a domain object
    @Override
    public List<Object> getFixtures() {
        return Collections.unmodifiableList(fixtures);
    }



    // Date and time

    /**
     * Will print warning message and do nothing if {@link FixtureClock} could
     * not be {@link FixtureClock#initialize() initialized}.
     *
     * @deprecated - use {@link FixtureScript} instead.
     */
    @Deprecated
    @Programmatic // to allow this class to be used as a domain object
    public void earlierDate(final int years, final int months, final int days) {
        if (shouldIgnoreCallBecauseNoClockSetup("earlierDate()")) {
            return;
        }
        clock.addDate(-years, -months, -days);
    }

    /**
     * Will print warning message and do nothing if {@link FixtureClock} could
     * not be {@link FixtureClock#initialize() initialized}.
     *
     * @deprecated - use {@link FixtureScript} instead.
     */
    @Deprecated
    @Programmatic // to allow this class to be used as a domain object
    public void earlierTime(final int hours, final int minutes) {
        if (shouldIgnoreCallBecauseNoClockSetup("earlierTime()")) {
            return;
        }
        clock.addTime(-hours, -minutes);
    }

    /**
     * Will print warning message and do nothing if {@link FixtureClock} could
     * not be {@link FixtureClock#initialize() initialized}.
     *
     * @deprecated - use {@link FixtureScript} instead.
     */
    @Deprecated
    @Programmatic // to allow this class to be used as a domain object
    public void laterDate(final int years, final int months, final int days) {
        if (shouldIgnoreCallBecauseNoClockSetup("laterDate()")) {
            return;
        }
        clock.addDate(years, months, days);
    }

    /**
     * Will print warning message and do nothing if {@link FixtureClock} could
     * not be {@link FixtureClock#initialize() initialized}.
     *
     * @deprecated - use {@link FixtureScript} instead.
     */
    @Deprecated
    @Programmatic // to allow this class to be used as a domain object
    public void laterTime(final int hours, final int minutes) {
        if (shouldIgnoreCallBecauseNoClockSetup("laterTime()")) {
            return;
        }
        clock.addTime(hours, minutes);
    }

}