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

import java.io.*;

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

public class RelSubFormRowKeys implements Serializable
{
    public static final RelSubFormRowKeys[] EMPTY_ARRAY = new RelSubFormRowKeys[0];

    private String[] mRowKeys = null; // The Rows for any sub-form which is
    private String mRelSubFormRef; //    relative to the parent form via this reference
    private FormDataRowKey mContainingRow; // and carried by the "row" (null == Root) under the
    private Integer mContainingFormUniqueID; // parent form

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

    public RelSubFormRowKeys( FormDataRowKey pContainingRow, Integer pContainingFormUniqueID, String pRelSubFormRef,
                              String[] pRowKeys )
    {
        mContainingRow = pContainingRow;
        mContainingFormUniqueID = pContainingFormUniqueID;
        mRelSubFormRef = Strings.noEmpty( pRelSubFormRef );
        if ( UtilsCommon.isNotNullOrEmpty( pRowKeys ) )
        {
            mRowKeys = pRowKeys;
        }
        LLvalidate();
    }

    private void LLvalidate()
    {
        Objects.assertNotNull( "ContainingFormUniqueID", mContainingFormUniqueID );
        Objects.assertNotNull( "RelSubFormRef", mRelSubFormRef );
    }

    public void validate()
    {
        LLvalidate();
    }

    public FormDataRowKey getContainingRow()
    {
        return mContainingRow;
    }

    public Integer getContainingFormUniqueID()
    {
        return mContainingFormUniqueID;
    }

    public String getRelSubFormRef()
    {
        return mRelSubFormRef;
    }

    public String[] getRowKeys()
    {
        return (mRowKeys != null) ? mRowKeys : Strings.EMPTY_ARRAY;
    }

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

    public StringBuilder toStringBuilder( StringBuilder pSB, int pDepth )
    {
        pSB.append( mContainingFormUniqueID );
        pSB.append( '-' );
        pSB.append( mRelSubFormRef );
        if ( mRowKeys != null )
        {
            pSB.append( '[' ).append( mRowKeys[0] );
            for ( int i = 1; i < mRowKeys.length; i++ )
            {
                pSB.append( ',' ).append( mRowKeys[i] );
            }
            pSB.append( ']' );
        }
        if ( mContainingRow != null )
        {
            pSB.append( " under: " );
            mContainingRow.toStringBuilder( pSB, pDepth );
        }
        return pSB;
    }
}