org.opengis.util.Record Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gt-opengis Show documentation
Standard interfaces implemented throughout the library.
The newest version!
/*
 *    GeoTools - The Open Source Java GIS Toolkit
 *    http://geotools.org
 *
 *    (C) 2011, Open Source Geospatial Foundation (OSGeo)
 *    (C) 2003-2005, Open Geospatial Consortium Inc.
 *
 *    All Rights Reserved. http://www.opengis.org/legal/
 */
package org.opengis.util;

import static org.opengis.annotation.Obligation.*;
import static org.opengis.annotation.Specification.*;

import java.util.Map;
import java.util.Set; // For Javadoc
import org.opengis.annotation.Extension;
import org.opengis.annotation.UML;

/**
 * A list of logically related elements as (name, value) pairs in a
 * dictionary. A record may be used as an implementation representation for features.
 *
 * This class can be think as the equivalent of the Java {@link Object} class.
 *
 * @author Bryce Nordgren (USDA)
 * @author Martin Desruisseaux (IRD)
 * @since GeoAPI 2.1
 * @see RecordType
 */
@UML(identifier = "Record", specification = ISO_19103)
public interface Record {
    /**
     * Returns the type definition of record. All attributes named in this record must be defined in
     * the returned record type. In other words, the following relationship must holds:
     *
     * 

     *
     * 

     *   getRecordType().{@linkplain RecordType#getAttributeTypes
     *        getAttributeTypes()}.{@linkplain Map#keySet keySet()}.{@linkplain
     *        Set#containsAll containsAll}({@linkplain #getAttributes()}.{@linkplain
     *        Map#keySet keySet()})
     * 
     *
     * This method can be think as the equivalent of the Java {@link Object#getClass()} method.
     */
    @UML(identifier = "recordType", obligation = OPTIONAL, specification = ISO_19103)
    RecordType getRecordType();

    /**
     * Returns the dictionary of all (name, value) pairs in this record. The
     * returned map shall not allows key addition. It may allows the replacement of existing keys
     * only.
     *
     * @see RecordType#getAttributeTypes
     */
    @UML(identifier = "attributes", obligation = MANDATORY, specification = ISO_19103)
    Map getAttributes();

    /**
     * Returns the value for an attribute of the specified name. This is functionnaly equivalent to
     * {@linkplain #getAttributes()}.{@linkplain Map#get get}(name). The type of the
     * returned object is given by 
     * {@linkplain #getRecordType()}.{@linkplain RecordType#locate locate}(name).
     *
     * @see RecordType#locate
     */
    @UML(identifier = "locate", obligation = MANDATORY, specification = ISO_19103)
    Object locate(MemberName name);

    /**
     * Set the value for the attribute of the specified name. This is functionally equivalent to
     * {@linkplain #getAttributes()}.{@linkplain Map#put put}(name,value). Remind that
     * {@code name} keys are constrained to {@linkplain RecordType#getMembers record type members}
     * only.
     *
     * @param name The name of the attribute to modify.
     * @param value The new value for the attribute.
     * @throws UnsupportedOperationException if this record is not modifiable.
     */
    @Extension
    void set(MemberName name, Object value) throws UnsupportedOperationException;
}