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

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

public abstract class AbstractFormUsage implements Comparable,
                                                   ToStringBuilder
{
    // Basic Base Form
    abstract public boolean isHot();

    abstract public String getRootType();

    // Basic Sub Form
    abstract public String getRelAttributeRef();

    // Shared
    abstract public Integer getUniqueID();

    abstract public IntendedUse getIntendedUse();

    abstract public LabelUsage[] getLabels();

    abstract public ActionUsage[] getActions();

    abstract public AttributeUsage[] getAttributes();

    abstract public FormUsage[] getRelSubForms();

    public boolean isBaseForm()
    {
        return (getRootType() != null);
    }

    public final int compareTo( AbstractFormUsage pThem )
    {
        Compare zCompare;
        if ( isBaseForm() )
        {
            zCompare = Compare.first( this.getRootType(), pThem.getRootType() );
            zCompare = zCompare.then( this.isHot(), pThem.isHot() );
        }
        else
        {
            zCompare = Compare.first( this.getRelAttributeRef(), pThem.getRelAttributeRef() );
        }
        zCompare = zCompare.then( this.getUniqueID(), pThem.getUniqueID() );
        zCompare = zCompare.then( this.getIntendedUse(), pThem.getIntendedUse() );
        return zCompare.result();
    }

    public final int compareTo( Object pObject )
    {
        return compareTo( (AbstractFormUsage) pObject );
    }

    protected final boolean LLequals( AbstractFormUsage pThem )
    {
        return (pThem != null) && //
               Objects.areNonArraysEqual( this.getRelAttributeRef(), pThem.getRelAttributeRef() ) && //
               Objects.areNonArraysEqual( this.getRootType(), pThem.getRootType() ) && //
               UtilsCommon.areNonArraysEqual( this.isHot(), pThem.isHot() ) && //
               Objects.areNonArraysEqual( this.getIntendedUse(), pThem.getIntendedUse() ) && //
               Objects.areNonArraysEqual( this.getUniqueID(), pThem.getUniqueID() );
    }

    public final int hashCode()
    {
        return getRootOrRel().hashCode();
    }

    protected final String getRootOrRel()
    {
        return isBaseForm() ? getRootType() : getRelAttributeRef();
    }

    public final StringBuilder toStringBuilder( StringBuilder pSB, int pDepth )
    {
        pSB.append( getIntendedUse() ).append( ',' ).append( getRootOrRel() );
        if ( isHot() )
        {
            pSB.append( " (-HOT-)" );
        }
        if ( anyChildren() )
        {
            pSB.append( ":" );
            int subDepth = pDepth + 1;

            addPreChildren( pSB, subDepth );
            add( pSB, subDepth, "Labels", getLabels() );
            add( pSB, subDepth, "Actions", getActions() );
            add( pSB, subDepth, "Attributes", getAttributes() );
            add( pSB, subDepth, "RelSubForms", getRelSubForms() );
            addPostChildren( pSB, subDepth );
        }
        return pSB;
    }

    protected void addPreChildren( StringBuilder pSB, int pDepth )
    {
    }

    protected void addPostChildren( StringBuilder pSB, int pDepth )
    {
    }

    abstract protected boolean anyChildren();

    protected static void add( StringBuilder pSB, int pDepth, String pWhat, ToStringBuilder[] pBuilders )
    {
        if ( pBuilders.length != 0 )
        {
            LineIndentUtil.newLine( pSB, pDepth++ ).append( pWhat ).append( ':' );
            for ( int i = 0; i < pBuilders.length; i++ )
            {
                pBuilders[i].toStringBuilder( LineIndentUtil.newLine( pSB, pDepth ), pDepth );
            }
        }
    }

    protected static String required( String pWhat, String pSource )
    {
        return UtilsCommon.assertNotNullNotEmpty( pWhat, pSource );
    }
}