PatternItem.java

////////////////////////////////////////////////////////////////////////////////
// Copyright 2013 Michael Schmalle - Teoti Graphix, LLC
// 
// 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
// 
// Author: Michael Schmalle, Principal Architect
// mschmalle at teotigraphix dot com
////////////////////////////////////////////////////////////////////////////////

package com.teotigraphix.caustk.system.bank;

import java.util.ArrayList;
import java.util.List;

import com.teotigraphix.caustic.internal.utils.PatternUtils;

/**
 * A {@link PatternItem} is an unserialized representation of a Caustic
 * {@link IMachine}s single pattern.
 * 
 * @author Work
 */
public class PatternItem extends MemorySlotItem {
    //--------------------------------------------------------------------------
    // Public API :: Properties
    //--------------------------------------------------------------------------

    //----------------------------------
    // phrases
    //----------------------------------

    private List<PhraseItem> phrases = new ArrayList<PhraseItem>();

    /**
     * Returns the list of {@link PhraseItem}s.
     */
    public List<PhraseItem> getPhrases() {
        return phrases;
    }

    //----------------------------------
    // bank
    //----------------------------------

    private final int bankIndex;

    /**
     * The bank index as it was loaded from the {@link IMachine}.
     */
    public final int getBankIndex() {
        return bankIndex;
    }

    //----------------------------------
    // patternIndex
    //----------------------------------

    private final int patternIndex;

    /**
     * The pattern index as it was loaded from the {@link IMachine}.
     */
    public final int getPatternIndex() {
        return patternIndex;
    }

    //----------------------------------
    // tempo
    //----------------------------------

    private int tempo;

    /**
     * The tempo of the pattern.
     * <p>
     * When loading by default, this is determined by the tempo of the
     * <code>.causitc</code> file it was loaded from.
     */
    public int getTempo() {
        return tempo;
    }

    //----------------------------------
    // length
    //----------------------------------

    private int length;

    /**
     * The length of the pattern as loaded from the {@link IMachine}.
     */
    public int getLength() {
        return length;
    }

    //--------------------------------------------------------------------------
    // Constructor
    //--------------------------------------------------------------------------

    public PatternItem(String patternName, int length, int tempo) {
        this.length = length;
        this.tempo = tempo;

        bankIndex = PatternUtils.toBank(patternName);
        patternIndex = PatternUtils.toPattern(patternName);
    }

    //--------------------------------------------------------------------------
    // Public API :: Methods
    //--------------------------------------------------------------------------

    /**
     * @param index
     * @return
     */
    public PhraseItem getPhraseAt(int index) {
        return phrases.get(index);
    }

    /**
     * @param item
     */
    public void addPhraseItem(PhraseItem item) {
        phrases.add(item);
    }
}