001    //$HeadURL: https://svn.wald.intevation.org/svn/deegree/base/branches/2.3_testing/src/org/deegree/model/feature/schema/FeatureType.java $
002    /*----------------------------------------------------------------------------
003     This file is part of deegree, http://deegree.org/
004     Copyright (C) 2001-2009 by:
005       Department of Geography, University of Bonn
006     and
007       lat/lon GmbH
008    
009     This library is free software; you can redistribute it and/or modify it under
010     the terms of the GNU Lesser General Public License as published by the Free
011     Software Foundation; either version 2.1 of the License, or (at your option)
012     any later version.
013     This library is distributed in the hope that it will be useful, but WITHOUT
014     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
015     FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
016     details.
017     You should have received a copy of the GNU Lesser General Public License
018     along with this library; if not, write to the Free Software Foundation, Inc.,
019     59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
020    
021     Contact information:
022    
023     lat/lon GmbH
024     Aennchenstr. 19, 53177 Bonn
025     Germany
026     http://lat-lon.de/
027    
028     Department of Geography, University of Bonn
029     Prof. Dr. Klaus Greve
030     Postfach 1147, 53001 Bonn
031     Germany
032     http://www.geographie.uni-bonn.de/deegree/
033    
034     e-mail: info@deegree.org
035    ----------------------------------------------------------------------------*/
036    
037    package org.deegree.model.feature.schema;
038    
039    import java.net.URI;
040    
041    import org.deegree.datatypes.QualifiedName;
042    
043    /**
044     * The FeatureType interface is intended to provide details of the type of a Feature that are
045     * described as Feature Schema in the Abstract Specification's Essential Model, specifically the
046     * names and types of the properties associated with each instance of a Feature of the given
047     * FeatureType.
048     * <p>
049     * -----------------------------------------------------------------------
050     * </p>
051     *
052     * @author <a href="mailto:poth@lat-lon.de">Andreas Poth</a>
053     * @version $Revision: 18195 $ $Date: 2009-06-18 17:55:39 +0200 (Do, 18. Jun 2009) $
054     */
055    public interface FeatureType {
056    
057        /**
058         * returns the name of the FeatureType
059         *
060         * @return name of the FeatureType
061         */
062        public QualifiedName getName();
063    
064        /**
065         * Returns whether this feature type is abstract or not.
066         *
067         * @return true, if the feature type is abstract, false otherwise
068         */
069        public boolean isAbstract();
070    
071        /**
072         * returns the namespace of the feature type (maybe null)
073         *
074         * @return the namespace of the feature type (maybe <code>null</code>)
075         */
076        public URI getNameSpace();
077    
078        /**
079         * returns the location of the XML schema defintion assigned to a namespace
080         *
081         * @return the location of the XML schema defintion assigned to a namespace
082         */
083        public URI getSchemaLocation();
084    
085        /**
086         * returns the name of the property a the passed index position
087         *
088         * @param index
089         * @return the name of the property a the passed index position
090         */
091        public QualifiedName getPropertyName( int index );
092    
093        /**
094         * returns the properties of this feature type
095         *
096         * @return type properties
097         */
098        public PropertyType[] getProperties();
099    
100        /**
101         * returns a property of this feature type identified by its name
102         *
103         * @param name
104         *            name of the desired property
105         * @return one named property
106         */
107        public PropertyType getProperty( QualifiedName name );
108    
109        /**
110         * returns the FeatureTypeProperties of type GEOMETRY
111         *
112         * @see org.deegree.datatypes.Types
113         * @return the FeatureTypeProperties of type GEOMETRY
114         */
115        public GeometryPropertyType[] getGeometryProperties();
116    
117        /**
118         * returns true if the passed FeatureType equals this FeatureType. Two FeatureTypes are equal if
119         * they have the same qualified name
120         *
121         * @param featureType
122         *
123         * @return <code>true</code> if the passed FeatureType equals this FeatureType.
124         */
125        public boolean equals( FeatureType featureType );
126    
127    }