Application: gvSIG desktop

/* gvSIG. Desktop Geographic Information System.

 *

 * Copyright ? 2007-2016 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 2

 * 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.raster;

import java.util.Iterator;

import org.gvsig.raster.lib.buffer.api.BufferManager;

import org.gvsig.raster.lib.buffer.api.NoData;

import org.gvsig.tools.dispose.Disposable;

import org.gvsig.tools.lang.Cloneable;

import org.gvsig.tools.persistence.Persistent;

/**

 * This class describes the available {@link BandAttributeDescriptor} of a band.

 *

 * @author <a href="mailto:lmarques@disid.com">Lluis Marques</a>

 *

 */

public interface BandDescriptor extends Iterable<BandAttributeDescriptor>, Persistent, Cloneable, Disposable {

    /**

     * Gets the store that the band belongs.

     * @return

     */

    public RasterStore getStore();

    /**

     * Gets band of this descriptor.

     *

     * @return Band

     */

    public int getBand();

    /**

     * Gets the {@link BandAttributeDescriptor} by index.

     *

     * @param index

     *            Index of {@link BandAttributeDescriptor}

     * @return BandAttributeDescriptor The {@link BandAttributeDescriptor}

     *         located at index. If there are not

     *         {@link BandAttributeDescriptor} at index, null will be returned.

     */

    public BandAttributeDescriptor get(int index);

    /**

     * Gets the {@link BandAttributeDescriptor} by name.

     *

     * @param name

     *            Name of {@link BandAttributeDescriptor}

     * @return BandAttributeDescriptor The {@link BandAttributeDescriptor}

     *         located at index. If there are not

     *         {@link BandAttributeDescriptor} whit the name, null will be returned.

     */

    public BandAttributeDescriptor get(String name);

    /**

     * Number of {@link BandAttributeDescriptor}.

     *

     * @return size Number of band attribute descriptor.

     */

    public int size();

    /**

     * @return Returns an iterator over the elements in this list in proper

     *         sequence.

     */

    public Iterator<BandAttributeDescriptor> iterator();

    /**

     * @return

     */

    public NoData getNoData();

    /**

     * @param noData

     */

    public void setNoData(NoData noData);

    /**

     * Gets the dataType.

     *

     * The possible data types are defined in {@link BufferManager}.

     *

     * The data type of the band can't be changed after being created.

     *

     * @return the data type

     */

    public int getDataType();

    /**

     * @return

     */

    public String getName();

    /**

     * @return

     */

    public String getDescription();

}