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;
033
034 import javax.swing.Icon;
035 import org.opengis.annotation.Extension;
036 import org.opengis.annotation.XmlElement;
037 import org.opengis.metadata.citation.OnlineResource;
038
039 /**
040 * The alternative to a WellKnownName is an external mark format. The MarkIndex
041 * allows an individual mark in a mark archive to be selected. An example format for an
042 * external mark archive would be a TrueType font file, with MarkIndex being used to
043 * select an individual glyph from that file.
044 *
045 * @version <A HREF="http://www.opengeospatial.org/standards/symbol">Symbology Encoding Implementation Specification 1.1.0</A>
046 * @author Open Geospatial Consortium
047 * @author Johann Sorel (Geomatys)
048 * @since GeoAPI 2.2
049 */
050 public interface ExternalMark {
051
052 /**
053 * Returns on online resource defined by an URI.
054 *
055 * Both OnlineResource and InlineContent can't be null and both
056 * can't be set at the same time.
057 *
058 * @return OnlineResource or null
059 */
060 @XmlElement("OnlineResource")
061 OnlineResource getOnlineResource();
062
063 /**
064 * Returns on inline content.
065 *
066 * Both OnlineResource and InlineContent can't be null and both
067 * can't be set at the same time.
068 *
069 * @return InlineContent or null
070 */
071 @XmlElement("InlineContent")
072 Icon getInlineContent();
073
074 /**
075 * Returns the mime type of the onlineResource/InlineContent
076 *
077 * @return mime type
078 */
079 @XmlElement("Format")
080 String getFormat();
081
082 /**
083 * Returns an integer value that can used for accessing a particular
084 * Font character in a TTF file or a catalog for example.
085 *
086 * @return integer
087 */
088 @XmlElement("MarkIndex")
089 int getMarkIndex();
090
091 /**
092 * calls the visit method of a StyleVisitor
093 *
094 * @param visitor the style visitor
095 */
096 @Extension
097 Object accept(StyleVisitor visitor, Object extraData);
098
099 }