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 java.util.List;
035
036 import org.opengis.filter.Filter;
037
038 /**
039 * The type of operations to be invoked on an attribute.
040 * <p>
041 * Invoking an operation on an attribute is used to calculate a derived quantity
042 * or update attribute state. OperationType is used to define the required
043 * parameters and expected result for an Operation.
044 *
045 * @author Jody Garnett, Refractions Research, Inc.
046 */
047 public interface OperationType extends PropertyType {
048
049 /**
050 * Access to super type information.
051 * <p>
052 * The super type of an operation provides additional
053 * restrictions and description for this operation.
054 * </p>
055 * @return super type
056 */
057 OperationType getSuper();
058
059 /**
060 * Indicate that this OperationType may not be used directly.
061 * <p>
062 * This indicates that a sub type will need to actually define the operation
063 * meaning here. As an example a graph system could have an Edge that would
064 * have "related" operation returning that was abstract, and a sub type road
065 * would define "related" based on touches, or "contains" or "common vertex".
066 * </p>
067 */
068 boolean isAbstract();
069
070 /**
071 * AttributeType this operation type can function against.
072 */
073 AttributeType getTarget();
074
075 /**
076 * Indicates the expected result type, may be <code>null</code>.
077 *
078 * @return expected result type, may be <code>null</code>
079 */
080 AttributeType getResult();
081
082 /**
083 * We need the following AttributeTypes as parameters.
084 * <p>
085 * Note we do not need AttributeDescriptors here as parameters
086 * are ordered, so name is not needed.
087 * </p>
088 * @return indicates paramters required for operation
089 */
090 List<AttributeType> getParameters();
091
092 /**
093 * List of restrictions used to limit the allowable returned value.
094 *
095 * @return Restrictions on valid return values
096 */
097 List<Filter> getRestrictions();
098 }