org.opengis.filter.identity.RecordId Maven / Gradle / Ivy

/*
 *    GeoTools - The Open Source Java GIS Toolkit
 *    http://geotools.org
 *
 *    (C) 2011, Open Source Geospatial Foundation (OSGeo)
 *    (C) 2005, Open Geospatial Consortium Inc.
 *
 *    All Rights Reserved. http://www.opengis.org/legal/
 */
package org.opengis.filter.identity;

import org.opengis.annotation.XmlElement;

/**
 * RecordId refered to by CSW-2 specification.
 *
 * Records are identified with a String, commonly referred to as an "id". We are using
 * SimpleFeature to represent a Record at the moment (since our Record does not have a getID()
 * method).
 *
 * @version Implementation specification 1.0
 * @author Jody Garnett, Refractions Research Inc.
 * @since GeoAPI 2.1
 */
@XmlElement("RecordId")
public interface RecordId extends Identifier {

    /** The identifier value, which is a string. */
    @XmlElement("id")
    String getID();

    /**
     * Evaluates the identifer value against the given record.
     *
     * @param record The recrod construct to be tested.
     * @return true if a match, otherwise false
     */
    boolean matches(Object record);
}