/*
 * Copyright (c) 2004, Stefan Walter
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *     * Redistributions of source code must retain the above
 *       copyright notice, this list of conditions and the
 *       following disclaimer.
 *     * Redistributions in binary form must reproduce the
 *       above copyright notice, this list of conditions and
 *       the following disclaimer in the documentation and/or
 *       other materials provided with the distribution.
 *     * The names of contributors to this software may not be
 *       used to endorse or promote products derived from this
 *       software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 *
 *
 * CONTRIBUTORS
 *  Stef Walter <stef@memberwebs.com>
 *
 */

package com.memberwebs.ldapxml.map;



/**
 * Represents a &lt;class&gt; in an LX map.
 *
 * @author stef@memberwebs.com
 * @version 0.5
 */
public class LXClass
    extends LXBase
{
    /**
     * Construct a new LXClass.
     *
     * @param parent This class's parent object in the LX map tree.
     */
    LXClass(LXBase parent)
    {
        super(parent);
        m_isInline = true;
        m_isInclusive = true;
    }

    /**
     * Returns an attribute of this class.
     *
     * @param name The attribute's name
     * @return The attrtibute, or null if no such attribute is present.
     */
    public LXAttribute getAttribute(String name)
    {
        LXAttribute attr = (LXAttribute)getChild(name);

        // If there is no such attribute and we're allowed
        // to just include everything, then...
        if(attr == null)
        {
            if(m_isInclusive)
            {
                // ... just create it on the fly.
                attr = new LXAttribute(this, true);
                attr.setName(name);
            }
        }

        // Check if we haven't been marked as unusable
        else if(!attr.isUseable())
        {
            attr = null;
        }

        return attr;
    }

    /**
     * Checks if this class' attributes go inline
     * or if the class gets it's own element in XML.
     *
     * @return Inline or not.
     */
    public final boolean isInline()
    {
        return m_isInline;
    }

    public final boolean isInclusive()
    {
        return m_isInclusive;
    }

    // Include all attributes not otherwise specified
    boolean m_isInclusive;

    // Create a class element around attributes in XML.
    boolean m_isInline;
};