001 /*
002 * GeoAPI - Java interfaces for OGC/ISO standards
003 * http://www.geoapi.org
004 *
005 * Copyright (C) 2004-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 java.util.Collection;
035 import javax.swing.Icon;
036 import org.opengis.annotation.Extension;
037 import org.opengis.annotation.XmlElement;
038 import org.opengis.metadata.citation.OnlineResource;
039
040
041 /**
042 * Points to an external file that contains an image of some kind, such as a CGM, JPG, or SVG.
043 *
044 * @version <A HREF="http://www.opengeospatial.org/standards/symbol">Symbology Encoding Implementation Specification 1.1.0</A>
045 * @author Open Geospatial Consortium
046 * @author Johann Sorel (Geomatys)
047 * @author Chris Dillard (SYS Technologies)
048 * @since GeoAPI 2.2
049 */
050 @XmlElement("ExternalGraphic")
051 public interface ExternalGraphic extends GraphicalSymbol {
052
053 /**
054 * Returns a OnlineResource to a file (perhaps a local file) that contains an image.
055 * This can be null if the image is already loaded locally and the
056 * {@link #getInlineContent InlineContent} property is set.
057 *
058 * @return OnlineResource
059 */
060 @XmlElement("OnlineResource")
061 OnlineResource getOnlineResource();
062
063 /**
064 * Returns the InlineContent that comprise the image. This overrides the
065 * {@link #getOnlineResource OnlineResource} property, if it is set.
066 *
067 * @return
068 */
069 @XmlElement("InlineContent")
070 Icon getInlineContent();
071
072 /**
073 * Returns the mime type of the onlineResource/InlineContent
074 *
075 * @return mime type
076 */
077 @XmlElement("Format")
078 String getFormat();
079
080 /**
081 * The ColorReplacement element, which may occur multiple times, allows to replace a
082 * color in the ExternalGraphic, the color specified in the OriginalColor sub-element, by
083 * another color as a result of a recode function as defined in {@link Interpolate} .
084 */
085 @XmlElement("ColorReplacement")
086 Collection<ColorReplacement> getColorReplacements();
087
088 /**
089 * calls the visit method of a StyleVisitor
090 *
091 * @param visitor the style visitor
092 */
093 @Extension
094 Object accept(StyleVisitor visitor, Object extraData);
095
096 }