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

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

public abstract class AttributeMetaData extends AbstractSharedMetaData
{
    public static final long serialVersionUID = -7546723672367674267L;

    private Integer mUniqueID;
    private String mAttributeReference;
    private IntendedUse mIntendedUse;
    private boolean mLabelLess;
    private Hintable.Hint[] mHints;

    /**
     * @deprecated GWT ONLY
     */
    public AttributeMetaData()
    {
    }

    public AttributeMetaData( AttributeUsage pUsage, boolean pDisabled, Hintable.Hint[] pHints,
                              String pExternalText, String pTooltip )
    {
        super( pUsage, pDisabled, pExternalText, pTooltip );
        mUniqueID = pUsage.getUniqueID();
        mAttributeReference = pUsage.getAttributeReference();
        mIntendedUse = pUsage.getIntendedUse();
        mLabelLess = pUsage.isLabelLess();
        mHints = Objects.isNotNullOrEmpty( pHints ) ? pHints : null;
    }

    public Integer getUniqueID()
    {
        return mUniqueID;
    }

    public String getAttributeReference()
    {
        return mAttributeReference;
    }

    public IntendedUse getIntendedUse()
    {
        return mIntendedUse;
    }

    public boolean isLabelLess()
    {
        return mLabelLess;
    }

    public Hintable.Hint[] getHints()
    {
        return mHints;
    }

    public String getHintValue( String pHintName )
    {
        if ( (pHintName != null) && (mHints != null) )
        {
            for ( int i = 0; i < mHints.length; i++ )
            {
                Hintable.Hint hint = mHints[i];
                if ( pHintName.equals( hint.getName() ) )
                {
                    return hint.getValue();
                }
            }
        }
        return null;
    }

    public boolean hasHint( String pHintName, String pValue )
    {
        return (pValue != null) && pValue.equals( getHintValue( pHintName ) );
    }

    public boolean equals( Object o )
    {
        return (this == o) || ((o instanceof AttributeMetaData) && equals( (AttributeMetaData) o ));
    }

    public boolean equals( AttributeMetaData them )
    {
        return (this == them) || ((them != null) //
                                  && them.innerEquals( this ) // Flip em for Detection of sub-classes
        );
    }

    protected boolean innerEquals( AttributeMetaData pThem )
    {
        return Objects.areNonArraysEqual( this.mUniqueID, pThem.mUniqueID ) && //
               Objects.areNonArraysEqual( this.mAttributeReference, pThem.mAttributeReference ) && //
               Objects.areNonArraysEqual( this.mIntendedUse, pThem.mIntendedUse ) && //
               Booleans.areNonArraysEqual( this.isDisabled(), pThem.isDisabled() );
    }

    public int hashCode()
    {
        return mUniqueID.hashCode();
    }

    public int compareTo( AttributeMetaData pThem )
    {
        // Flip em for Detection of sub-classes
        return -(pThem.innerCompareTo( this ));
    }

    protected int innerCompareTo( AttributeMetaData pThem )
    {
        return Compare.first( this.mAttributeReference, pThem.mAttributeReference //
        ).then( this.mIntendedUse, pThem.mIntendedUse //
        ).then( this.isDisabled(), pThem.isDisabled() //
        ).then( this.mUniqueID, pThem.mUniqueID //
        ).result();
    }

    public int compareTo( Object pObject )
    {
        return compareTo( (AttributeMetaData) pObject );
    }

    public abstract String getWhatWeAre();

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

    public StringBuilder toStringBuilder( StringBuilder pSB, int pDepth )
    {
        pSB.append( "'" ).append( mAttributeReference ).append( "'" );
        if ( mIntendedUse != null )
        {
            pSB.append( ',' ).append( mIntendedUse );
        }
        if ( isLabelLess() || isDisabled() )
        {
            pSB.append( '[' );
            if ( isLabelLess() )
            {
                pSB.append( "LabelLess" );
                if ( isDisabled() )
                {
                    pSB.append( ',' );
                }
            }
            if ( isDisabled() )
            {
                pSB.append( "Disabled" );
            }
            pSB.append( ']' );
        }
        pSB.append( "->" ).append( getWhatWeAre() ).append( '-' );
        pSB.append( "'" ).append( getExternalText() ).append( "','" ).append( getTooltip() ).append( "'" );
        addAdditionalSimpleAttributes( pSB );
        if ( mHints != null )
        {
            LineIndentUtil.newLine( pSB, ++pDepth ).append( "Hints" ).append( ':' );
            pDepth++;
            for ( int i = 0; i < mHints.length; i++ )
            {
                Hintable.Hint hint = mHints[i];
                LineIndentUtil.newLine( pSB, pDepth );
                pSB.append( hint.getName() ).append( '=' ).append( hint.getValue() );
            }
        }
        return pSB;
    }

    protected void addAdditionalSimpleAttributes( StringBuilder pSB )
    {
    }
}