/*
 *    Geotoolkit - An Open Source Java GIS Toolkit
 *    http://www.geotoolkit.org
 *
 *    (C) 2010, Geomatys
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License as published by the Free Software Foundation; either
 *    version 2.1 of the License, or (at your option) any later version.
 *
 *    This library 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
 *    Lesser General Public License for more details.
 */
package org.geotoolkit.data.kml.model;

import java.util.Map;
import org.opengis.feature.Feature;

/**
 * <p>This interface maps a kml element</p>
 *
 * <pre>
 * <element name="kml" type="kml:KmlType"/>
 *
 * <complexType name="KmlType" final="#all">
 *  <sequence>
 *      <element ref="kml:NetworkLinkControl" minOccurs="0"/>
 *      <element ref="kml:AbstractFeatureGroup" minOccurs="0"/>
 *      <element ref="kml:KmlSimpleExtensionGroup" minOccurs="0" maxOccurs="unbounded"/>
 *      <element ref="kml:KmlObjectExtensionGroup" minOccurs="0" maxOccurs="unbounded"/>
 *  </sequence>
 *  <attribute name="hint" type="string"/>
 * </complexType>
 *
 * <lement name="KmlSimpleExtensionGroup" abstract="true" type="anySimpleType"/>
 * <element name="KmlObjectExtensionGroup" abstract="true" substitutionGroup="kml:AbstractObjectGroup"/>
 * </pre>
 *
 * @author Samuel Andrés
 * @module
 */
public interface Kml {

    /**
     *
     * @return
     */
    String getVersion();

    /**
     *
     * @return The Kml NetworkLinkControl.
     */
    NetworkLinkControl getNetworkLinkControl();

    /**
     *
     * @return The Kml AbstractFeature.
     */
    Feature getAbstractFeature();

    /**
     *
     * @return A lis of extensions used by the Kml object.
     */
    Map<String, String> getExtensionsUris();

    /**
     * 
     * @param version
     */
    void setVersion(String version) throws KmlException;

    /**
     * 
     * @param networkLinkControl
     */
    void setNetworkLinkControl(NetworkLinkControl networkLinkControl);

    /**
     * 
     * @param feature
     */
    void setAbstractFeature(Feature feature);

    /**
     *
     * @param extensionsUris
     */
    void setExtensionsUris(Map<String, String> extensionsUris);

    /**
     * 
     * @param uri
     * @param prefix
     */
    void addExtensionUri(String uri, String prefix);

    /**
     * 
     * @return
     */
    Extensions extensions();

}