001 /*
002 * GeoAPI - Java interfaces for OGC/ISO standards
003 * http://www.geoapi.org
004 *
005 * Copyright (C) 2008-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.style.portrayal;
033
034 import org.opengis.util.InternationalString;
035 import org.opengis.annotation.UML;
036
037 import static org.opengis.annotation.Obligation.*;
038 import static org.opengis.annotation.Specification.*;
039
040 /**
041 * AttributDefinition is used to define the formal parameters of external functions and the underlying
042 * rendering operations of the portrayal service.
043 *
044 * @version <A HREF="http://www.isotc211.org">ISO 19117 Portrayal</A>
045 * @author Open Geospatial Consortium
046 * @author Johann Sorel (Geomatys)
047 * @since GeoAPI 2.2
048 */
049 @UML(identifier="PF_AttributeDefinition", specification=ISO_19117)
050 public interface AttributeDefinition {
051
052 /**
053 * Returns the name of the attribute definition.
054 * It shall be a legal and unique name for this function.
055 *
056 * @return String
057 */
058 @UML(identifier="name", obligation=MANDATORY, specification=ISO_19117)
059 String getName();
060
061 /**
062 * Returns a description of the usage of this attribute.
063 * It is a human readable value.
064 *
065 * @return InternationalString
066 */
067 @UML(identifier="description", obligation=OPTIONAL, specification=ISO_19117)
068 InternationalString getDescription();
069
070 /**
071 * Returns the class type for this attribute.
072 * It shall be a basic legal type.
073 *
074 * @return Class
075 */
076 @UML(identifier="type", obligation=MANDATORY, specification=ISO_19117)
077 Class getReturnType();
078
079 /**
080 * Returns a Default Value for this attribut.
081 * This value is optional.
082 *
083 * @return
084 */
085 @UML(identifier="defaultValue", obligation=OPTIONAL, specification=ISO_19117)
086 Object getDefault();
087
088 }