001    /*
002     *    GeoAPI - Java interfaces for OGC/ISO standards
003     *    http://www.geoapi.org
004     *
005     *    Copyright (C) 2006-2012 Open Geospatial Consortium, Inc.
006     *    All Rights Reserved. http://www.opengeospatial.org/ogc/legal
007     *
008     *    Permission to use, copy, and modify this software and its documentation, with
009     *    or without modification, for any purpose and without fee or royalty is hereby
010     *    granted, provided that you include the following on ALL copies of the software
011     *    and documentation or portions thereof, including modifications, that you make:
012     *
013     *    1. The full text of this NOTICE in a location viewable to users of the
014     *       redistributed or derivative work.
015     *    2. Notice of any changes or modifications to the OGC files, including the
016     *       date changes were made.
017     *
018     *    THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE
019     *    NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
020     *    TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT
021     *    THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY
022     *    PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
023     *
024     *    COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR
025     *    CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION.
026     *
027     *    The name and trademarks of copyright holders may NOT be used in advertising or
028     *    publicity pertaining to the software without specific, written prior permission.
029     *    Title to copyright in this software and any associated documentation will at all
030     *    times remain with copyright holders.
031     */
032    package org.opengis.feature.type;
033    
034    import org.opengis.feature.Attribute;
035    
036    /**
037     * The type of an attribute.
038     * <p>
039     * An attribute is similar to the notion of a UML attribute, or a field of a java
040     * object. See the javadoc of {@link Attribute} for more info on the semantics
041     * of attributes.
042     * </p>
043     * <p>
044     * <h3>Identifiablily</h3>
045     * An attribute may be "identifiable". When this is the case the attribute has a
046     * unique identifier associated with it. See {@link Attribute#getID()}. The type
047     * of the attribute specifies wether it is identifiable or not ({@link #isIdentified()}.
048     * </p>
049     *
050     * @author Jody Garnett, Refractions Research
051     * @author Justin Deoliveira, The Open Planning Project
052     */
053    public interface AttributeType extends PropertyType {
054    
055        /**
056         * Indicates if the type is identified or not.
057         * <p>
058         * If this method returns <code>true</code>, then the corresponding
059         * attribute must have a unique identifier, ie, {@link Attribute#getID()}
060         * must return a value, and cannot be <code>null</code>.
061         * </p>
062         *
063         * @return <code>true</code> if the attribute is identified, otherwise <code>false</code>.
064         *
065         * @see Attribute#getID()
066         */
067        boolean isIdentified();
068    
069        /**
070         * Override of {@link PropertyType#getSuper()} which type narrows to
071         * {@link AttributeType}.
072         *
073         * @see PropertyType#getSuper()
074         */
075        AttributeType getSuper();
076    }