// This Source Code is in the Public Domain per: http://litesoft.org/License.txt
package org.litesoft.ui.def.nonpublic.support;

import java.util.*;

import org.litesoft.core.typeutils.*;
import org.litesoft.core.util.*;
import org.litesoft.ui.support.*;

public class FormUsageCollector extends AbstractFormUsage
{
    // Basic Base Form
    private boolean mHot = false;
    private String mRootType = null;

    // Basic Sub Form
    private FormUsageCollector mParent = null;
    private String mRelAttributeRef = null;

    // Shared
    private Integer mUniqueID = null;
    private IntendedUse mIntendedUse = null;
    private Set mLabels = new HashSet(); // LabelUsage
    private Set mActions = new HashSet(); // ActionUsage
    private Set mAttributes = new HashSet(); // AttributeUsage
    private Set mRelSubForms = new HashSet(); // FormUsage

    // Base Form
    public FormUsageCollector( Integer pUniqueID, String pRootType, boolean pHot, IntendedUse pIntendedUse )
    {
        this( pUniqueID );
        mRootType = required( "RootType", pRootType );
        mHot = pHot;
        Objects.assertNotNull( "IntendedUse", mIntendedUse = pIntendedUse );
    }

    // Sub Form
    public FormUsageCollector( Integer pUniqueID, String pRelAttributeRef, FormUsageCollector pParent )
    {
        this( pUniqueID );
        mRelAttributeRef = required( "RelAttributeRef", pRelAttributeRef );
        Objects.assertNotNull( "Parent", mParent = pParent );
        mIntendedUse = mParent.getIntendedUse();
    }

    // Shared
    private FormUsageCollector( Integer pUniqueID )
    {
        Objects.assertNotNull( "UniqueID", mUniqueID = pUniqueID );
    }

    public Integer getUniqueID()
    {
        return mUniqueID;
    }

    public String getRelAttributeRef()
    {
        return mRelAttributeRef;
    }

    public boolean isHot()
    {
        return mHot;
    }

    public String getRootType()
    {
        return mRootType;
    }

    public IntendedUse getIntendedUse()
    {
        return mIntendedUse;
    }

    public void addLabel( LabelUsage pUsage )
    {
        addToSet( mLabels, pUsage );
    }

    public void addAction( ActionUsage pUsage )
    {
        addToSet( mActions, pUsage );
    }

    public void addAttribute( AttributeUsage pUsage )
    {
        addToSet( mAttributes, pUsage );
    }

    public void addRelSubForm( FormUsage pUsage )
    {
        addToSet( mRelSubForms, pUsage );
    }

    public void promoteToParent()
    {
        mParent.addRelSubForm( getFormUsage() );
    }

    public FormUsage getFormUsage()
    {
        LabelUsage[] zLabelUsage = getLabels();
        ActionUsage[] zActionUsage = getActions();
        AttributeUsage[] zAttributeUsage = getAttributes();
        FormUsage[] zFormUsages = getRelSubForms();
        return new FormUsage( isBaseForm(), getRootOrRel(), isHot(), getUniqueID(), mIntendedUse, //
                              zLabelUsage, //
                              zActionUsage, //
                              zAttributeUsage, //
                              zFormUsages );
    }

    public FormUsage[] getRelSubForms()
    {
        return (FormUsage[]) toArray( mRelSubForms, new FormUsage[mRelSubForms.size()] );
    }

    public AttributeUsage[] getAttributes()
    {
        return (AttributeUsage[]) toArray( mAttributes, new AttributeUsage[mAttributes.size()] );
    }

    public ActionUsage[] getActions()
    {
        return (ActionUsage[]) toArray( mActions, new ActionUsage[mActions.size()] );
    }

    public LabelUsage[] getLabels()
    {
        return (LabelUsage[]) toArray( mLabels, new LabelUsage[mLabels.size()] );
    }

    public void pushIntendedUse( IntendedUse pIntendedUse )
    {
        mSavedIntendedUses.push( mIntendedUse );
        if ( pIntendedUse != null )
        {
            mIntendedUse = pIntendedUse;
        }
    }

    public void popIntendedUse()
    {
        mIntendedUse = (IntendedUse) mSavedIntendedUses.pop();
    }

    private Stack mSavedIntendedUses = new Stack();

    private void addToSet( Set pSet, Object pUsage )
    {
        if ( pUsage != null )
        {
            pSet.add( pUsage );
        }
    }

    private Object[] toArray( Set pEntries, Object[] pUsages )
    {
        Arrays.sort( Objects.copyArrayTo( pEntries.toArray(), pUsages ) );
        return pUsages;
    }

    public String toString()
    {
        return toStringBuilder( new StringBuilder().append( "FormUsageCollector-" ), 0 ).toString();
    }

    protected boolean anyChildren()
    {
        return (mParent != null) || !mSavedIntendedUses.isEmpty() || !mLabels.isEmpty() ||
               !mActions.isEmpty() || !mAttributes.isEmpty() || !mRelSubForms.isEmpty();
    }

    protected void addPreChildren( StringBuilder pSB, int pDepth )
    {
        IntendedUse[] usages = (IntendedUse[]) Objects.copyArrayTo( mSavedIntendedUses.toArray(),
                                                                    new IntendedUse[mSavedIntendedUses.size()] );
        add( pSB, pDepth, "SavedIntendedUsages", usages );
    }

    protected void addPostChildren( StringBuilder pSB, int pDepth )
    {
        if ( mParent != null )
        {
            LineIndentUtil.newLine( pSB, pDepth ).append( "Parent-" );
            mParent.toStringBuilder( pSB, pDepth );
        }
    }
}