001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.rdf.serialize;
031
032import java.lang.annotation.Retention;
033import java.lang.annotation.RetentionPolicy;
034
035/**
036 * An annotation for members of classes that can be serialized as relationships
037 * in an RDF graph by the {@link RDFSerializer}, this annotation should provide
038 * the URI of the predicate to use for the field.
039 * <p>
040 * For example:
041 * <code><pre>
042 *              class PersonClass
043 *              {
044 *                      @Predicate("http://example.com/hasFirstName")
045 *                      public String firstName = "Jon";
046 *              }
047 * </pre></code>
048 * ...will be encoded to:
049 * <code><pre>
050 *              http://example.com/PersonClass
051 *                      http://example.com/hasFirstName "Jon".
052 * </pre></code>
053 * <p>
054 * If this annotation is not used, the {@link RDFSerializer} will, by default,
055 * ignore the field.  If the {@link RDFSerializer} is set to automatically create
056 * predicates, the predicate will end up being called
057 * {@code http://example.com/MyClass_hasFirstName}.
058 *
059 * @author David Dupplaw (dpd@ecs.soton.ac.uk)
060 * @created 11 Sep 2012
061 * @version $Author$, $Revision$, $Date$
062 */
063@Retention(RetentionPolicy.RUNTIME)
064public @interface Predicate {
065        /** The URI of the predicate */
066        public String value();
067}