Application: gvSIG desktop

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 gvSIG Association.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 3

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.fmap.dal.feature;

import java.util.Iterator;

/**

 * This is a container for FeatureRules.

 * Besides getting a rule by index, this structure allows 

 * adding a rule, removing a rule, iterating over the rules and copying 

 * the whole structure.

 *

 */

public interface FeatureRules extends Iterable<FeatureRule> {

        /**

         * Returns an object given its index.

         * 

         * @param index

         *                         a position in this <code>FeatureRules</code>

         * @return

         *                 the object found in the given index

         */

        public Object get(int index);

        /**

         * Returns a {@link FeatureRule} given its index.

         * 

         * @param index

         *                         a position in this <code>FeatureRules</code>

         * @return

         *                 the {@link FeatureRule} found in the given index

         */

        public FeatureRule getRule(int index);

        /**

         * Adds a new rule to this FeatureRules.

         * 

         * @param rule

         *                         the new rule to add.

         * @return

         *                 

         */

        public boolean add(FeatureRule rule);

        /**

         * Returns the number of rules contained in this FeatureRules.

         * 

         * @return

         *                 number of rules in this FeatureRules

         */

        public int size();

    public boolean isEmpty();

        /**

         * Clears this FeatureRules from any rules.

         */

        public void clear();

        /**

         * Removes the rule stored in the given index.

         * 

         * @param index

         *                         index of the rule to remove.

         * @return

         *                 returns the removed rule

         */

        public Object remove(int index);

        /**

         * Removes the given rule from this FeatureRules.

         * 

         * @param rule

         *                         FeatureRule to remove

         * @return

         *                 true indicates success, false indicates that it was not found.

         */

        public boolean remove(FeatureRule rule);

        /**

         * Returns an iterator over the available {@link FeatureRule}(s)

         * 

         * @return

         *                 an iterator over the available {@link FeatureRule}(s)

         */

        @Override

        public Iterator<FeatureRule> iterator();

        /**

         * Returns a new copy of this FeatureRules.

         * 

         * @return

         *                 a new copy of this FeatureRules.

         */

        public FeatureRules getCopy();

}