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    /**
035     * Describes an instance of an Attribute.
036     * <p>
037     * An AttributeDescriptor is an extension of {@link PropertyDescriptor} which
038     * defines some additional information:
039     * <ul>
040     *   <li>A default value for an attribute
041     * </ul>
042     * </p>
043     * <p>
044     *
045     * @author Jody Garnett, Refractions Research
046     * @author Justin Deoliveira, The Open Planning Project
047     */
048    public interface AttributeDescriptor extends PropertyDescriptor {
049    
050        /**
051         * Override of {@link PropertyDescriptor#getType()} which type narrows to
052         * {@link AttributeType}.
053         *
054         *  @see PropertyDescriptor#getType()
055         */
056        AttributeType getType();
057    
058        /**
059         * The local name for this AttributeDescriptor.
060         * Specifically this returns <code>getName().getLocalPart</code>().
061         * @return The local name for this attribute descriptor.
062         */
063        String getLocalName();
064    
065        /**
066         * The default value for the attribute.
067         * <p>
068         * This value is used when an attribute is created and no value for it is
069         * specified.
070         * </p>
071         * <p>
072         * This value may be <code>null</code>. If it is non-null it should be an
073         * instance of of the class specified by <code>getType().getBinding()</code>.
074         * </p>
075         */
076        Object getDefaultValue();
077    }