| 1 | /*
|
|---|
| 2 | * GeoTools - The Open Source Java GIS Toolkit
|
|---|
| 3 | * http://geotools.org
|
|---|
| 4 | *
|
|---|
| 5 | * (C) 2011, Open Source Geospatial Foundation (OSGeo)
|
|---|
| 6 | * (C) 2004-2007 Open Geospatial Consortium Inc.
|
|---|
| 7 | *
|
|---|
| 8 | * All Rights Reserved. http://www.opengis.org/legal/
|
|---|
| 9 | */
|
|---|
| 10 | package org.opengis.feature.type;
|
|---|
| 11 |
|
|---|
| 12 | /**
|
|---|
| 13 | * Describes an instance of an Attribute.
|
|---|
| 14 | * <p>
|
|---|
| 15 | * An AttributeDescriptor is an extension of {@link PropertyDescriptor} which
|
|---|
| 16 | * defines some additional information:
|
|---|
| 17 | * <ul>
|
|---|
| 18 | * <li>A default value for an attribute
|
|---|
| 19 | * </ul>
|
|---|
| 20 | * </p>
|
|---|
| 21 | * <p>
|
|---|
| 22 | *
|
|---|
| 23 | * @author Jody Garnett, Refractions Research
|
|---|
| 24 | * @author Justin Deoliveira, The Open Planning Project
|
|---|
| 25 | *
|
|---|
| 26 | * @source $URL: http://svn.osgeo.org/geotools/branches/2.7.x/modules/library/opengis/src/main/java/org/opengis/feature/type/AttributeDescriptor.java $
|
|---|
| 27 | */
|
|---|
| 28 | public interface AttributeDescriptor extends PropertyDescriptor {
|
|---|
| 29 |
|
|---|
| 30 | /**
|
|---|
| 31 | * Override of {@link PropertyDescriptor#getType()} which type narrows to
|
|---|
| 32 | * {@link AttributeType}.
|
|---|
| 33 | *
|
|---|
| 34 | * @see PropertyDescriptor#getType()
|
|---|
| 35 | */
|
|---|
| 36 | AttributeType getType();
|
|---|
| 37 |
|
|---|
| 38 | /**
|
|---|
| 39 | * The local name for this AttributeDescriptor.
|
|---|
| 40 | * Specifically this returns <code>getName().getLocalPart</code>().
|
|---|
| 41 | * @return The local name for this attribute descriptor.
|
|---|
| 42 | */
|
|---|
| 43 | String getLocalName();
|
|---|
| 44 |
|
|---|
| 45 | /**
|
|---|
| 46 | * The default value for the attribute.
|
|---|
| 47 | * <p>
|
|---|
| 48 | * This value is used when an attribute is created and no value for it is
|
|---|
| 49 | * specified.
|
|---|
| 50 | * </p>
|
|---|
| 51 | * <p>
|
|---|
| 52 | * This value may be <code>null</code>. If it is non-null it should be an
|
|---|
| 53 | * instance of of the class specified by <code>getType().getBinding()</code>.
|
|---|
| 54 | * </p>
|
|---|
| 55 | */
|
|---|
| 56 | Object getDefaultValue();
|
|---|
| 57 | }
|
|---|
