org.openstreetmap.josm.data.imagery
Class ImageryInfo

java.lang.Object
  extended by org.openstreetmap.josm.data.imagery.ImageryInfo
All Implemented Interfaces:
java.lang.Comparable<ImageryInfo>, Attributed

public class ImageryInfo
extends java.lang.Object
implements java.lang.Comparable<ImageryInfo>, Attributed

Class that stores info about an image background layer.


Nested Class Summary
static class ImageryInfo.ImageryBounds
           
static class ImageryInfo.ImageryPreferenceEntry
          auxiliary class to save an ImageryInfo object in the preferences
static class ImageryInfo.ImageryType
           
 
Field Summary
private  java.lang.String attributionImage
           
private  java.lang.String attributionImageURL
           
private  java.lang.String attributionLinkURL
           
private  java.lang.String attributionText
           
private  ImageryInfo.ImageryBounds bounds
           
private  java.lang.String cookies
           
private  java.lang.String countryCode
           
private  boolean defaultEntry
           
private  int defaultMaxZoom
           
private  int defaultMinZoom
           
private  java.lang.String eulaAcceptanceRequired
           
private  java.lang.String icon
           
private  ImageryInfo.ImageryType imageryType
           
private  java.lang.String name
           
private  double pixelPerDegree
           
private  java.util.List<java.lang.String> serverProjections
           
private  java.lang.String termsOfUseText
           
private  java.lang.String termsOfUseURL
           
private  java.lang.String url
           
 
Constructor Summary
ImageryInfo()
           
ImageryInfo(ImageryInfo.ImageryPreferenceEntry e)
           
ImageryInfo(ImageryInfo i)
           
ImageryInfo(java.lang.String name)
           
ImageryInfo(java.lang.String name, java.lang.String url)
           
ImageryInfo(java.lang.String name, java.lang.String url, java.lang.String eulaAcceptanceRequired)
           
ImageryInfo(java.lang.String name, java.lang.String url, java.lang.String cookies, double pixelPerDegree)
           
ImageryInfo(java.lang.String name, java.lang.String url, java.lang.String eulaAcceptanceRequired, java.lang.String cookies)
           
ImageryInfo(java.lang.String name, java.lang.String url, java.lang.String type, java.lang.String eulaAcceptanceRequired, java.lang.String cookies)
           
 
Method Summary
 int compareTo(ImageryInfo in)
           
 void copyAttribution(ImageryInfo i)
           
 boolean equals(java.lang.Object o)
           
 boolean equalsBaseValues(ImageryInfo in)
           
 java.awt.Image getAttributionImage()
           
 java.lang.String getAttributionImageURL()
           
 java.lang.String getAttributionLinkURL()
           
 java.lang.String getAttributionText(int zoom, Coordinate topLeft, Coordinate botRight)
           
 ImageryInfo.ImageryBounds getBounds()
           
 java.lang.String getCookies()
           
 java.lang.String getCountryCode()
           
 java.lang.String getEulaAcceptanceRequired()
           
 java.lang.String getExtendedUrl()
           
 java.lang.String getIcon()
           
 ImageryInfo.ImageryType getImageryType()
           
 int getMaxZoom()
           
 java.lang.String getMenuName()
           
 int getMinZoom()
           
 java.lang.String getName()
           
 double getPixelPerDegree()
           
 java.util.List<java.lang.String> getServerProjections()
          Get the projections supported by the server.
 java.lang.String getTermsOfUseText()
           
 java.lang.String getTermsOfUseURL()
           
 java.lang.String getToolbarName()
           
 java.lang.String getUrl()
           
 boolean hasAttribution()
           
 int hashCode()
           
 boolean isBlacklisted()
          Returns true if this layer's URL is matched by one of the regular expressions kept by the current OsmApi instance.
 boolean isDefaultEntry()
           
 boolean requiresAttribution()
           
 void setAttribution(AbstractTileSource s)
          Applies the attribution from this object to a TMSTileSource.
 void setAttributionImage(java.lang.String text)
           
 void setAttributionImageURL(java.lang.String text)
           
 void setAttributionLinkURL(java.lang.String text)
           
 void setAttributionText(java.lang.String text)
           
 void setBounds(ImageryInfo.ImageryBounds b)
           
 void setCountryCode(java.lang.String countryCode)
           
 void setDefaultEntry(boolean defaultEntry)
           
 void setDefaultMaxZoom(int defaultMaxZoom)
           
 void setDefaultMinZoom(int defaultMinZoom)
           
 void setEulaAcceptanceRequired(java.lang.String eulaAcceptanceRequired)
           
 void setExtendedUrl(java.lang.String url)
           
 void setIcon(java.lang.String icon)
           
 void setImageryType(ImageryInfo.ImageryType imageryType)
           
 void setName(java.lang.String name)
           
 void setPixelPerDegree(double ppd)
           
 void setServerProjections(java.util.Collection<java.lang.String> serverProjections)
           
 void setTermsOfUseText(java.lang.String text)
           
 void setTermsOfUseURL(java.lang.String text)
           
 void setUrl(java.lang.String url)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

name

private java.lang.String name

url

private java.lang.String url

defaultEntry

private boolean defaultEntry

cookies

private java.lang.String cookies

eulaAcceptanceRequired

private java.lang.String eulaAcceptanceRequired

imageryType

private ImageryInfo.ImageryType imageryType

pixelPerDegree

private double pixelPerDegree

defaultMaxZoom

private int defaultMaxZoom

defaultMinZoom

private int defaultMinZoom

bounds

private ImageryInfo.ImageryBounds bounds

serverProjections

private java.util.List<java.lang.String> serverProjections

attributionText

private java.lang.String attributionText

attributionLinkURL

private java.lang.String attributionLinkURL

attributionImage

private java.lang.String attributionImage

attributionImageURL

private java.lang.String attributionImageURL

termsOfUseText

private java.lang.String termsOfUseText

termsOfUseURL

private java.lang.String termsOfUseURL

countryCode

private java.lang.String countryCode

icon

private java.lang.String icon
Constructor Detail

ImageryInfo

public ImageryInfo()

ImageryInfo

public ImageryInfo(java.lang.String name)

ImageryInfo

public ImageryInfo(java.lang.String name,
                   java.lang.String url)

ImageryInfo

public ImageryInfo(java.lang.String name,
                   java.lang.String url,
                   java.lang.String eulaAcceptanceRequired)

ImageryInfo

public ImageryInfo(java.lang.String name,
                   java.lang.String url,
                   java.lang.String eulaAcceptanceRequired,
                   java.lang.String cookies)

ImageryInfo

public ImageryInfo(java.lang.String name,
                   java.lang.String url,
                   java.lang.String type,
                   java.lang.String eulaAcceptanceRequired,
                   java.lang.String cookies)

ImageryInfo

public ImageryInfo(java.lang.String name,
                   java.lang.String url,
                   java.lang.String cookies,
                   double pixelPerDegree)

ImageryInfo

public ImageryInfo(ImageryInfo.ImageryPreferenceEntry e)

ImageryInfo

public ImageryInfo(ImageryInfo i)
Method Detail

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

compareTo

public int compareTo(ImageryInfo in)
Specified by:
compareTo in interface java.lang.Comparable<ImageryInfo>

equalsBaseValues

public boolean equalsBaseValues(ImageryInfo in)

setPixelPerDegree

public void setPixelPerDegree(double ppd)

setDefaultMaxZoom

public void setDefaultMaxZoom(int defaultMaxZoom)

setDefaultMinZoom

public void setDefaultMinZoom(int defaultMinZoom)

setBounds

public void setBounds(ImageryInfo.ImageryBounds b)

getBounds

public ImageryInfo.ImageryBounds getBounds()

requiresAttribution

public boolean requiresAttribution()
Specified by:
requiresAttribution in interface Attributed
Returns:
True if the tile source requires attribution in text or image form.

getAttributionText

public java.lang.String getAttributionText(int zoom,
                                           Coordinate topLeft,
                                           Coordinate botRight)
Specified by:
getAttributionText in interface Attributed
Parameters:
zoom - The optional zoom level for the view.
topLeft - The top left of the bounding box for attribution.
botRight - The bottom right of the bounding box for attribution.
Returns:
Attribution text for the image source.

getAttributionLinkURL

public java.lang.String getAttributionLinkURL()
Specified by:
getAttributionLinkURL in interface Attributed
Returns:
The URL to open when the user clicks the attribution text.

getAttributionImage

public java.awt.Image getAttributionImage()
Specified by:
getAttributionImage in interface Attributed
Returns:
The URL for the attribution image. Null if no image should be displayed.

getAttributionImageURL

public java.lang.String getAttributionImageURL()
Specified by:
getAttributionImageURL in interface Attributed
Returns:
The URL to open when the user clicks the attribution image. When return value is null, the image is still displayed (provided getAttributionImage() returns a value other than null), but the image does not link to a website.

getTermsOfUseText

public java.lang.String getTermsOfUseText()
Specified by:
getTermsOfUseText in interface Attributed
Returns:
The attribution "Terms of Use" text. In case it returns null, but getTermsOfUseURL() is not null, a default terms of use text is used.

getTermsOfUseURL

public java.lang.String getTermsOfUseURL()
Specified by:
getTermsOfUseURL in interface Attributed
Returns:
The URL to open when the user clicks the attribution "Terms of Use" text.

setAttributionText

public void setAttributionText(java.lang.String text)

setAttributionImageURL

public void setAttributionImageURL(java.lang.String text)

setAttributionImage

public void setAttributionImage(java.lang.String text)

setAttributionLinkURL

public void setAttributionLinkURL(java.lang.String text)

setTermsOfUseText

public void setTermsOfUseText(java.lang.String text)

setTermsOfUseURL

public void setTermsOfUseURL(java.lang.String text)

setExtendedUrl

public void setExtendedUrl(java.lang.String url)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getUrl

public java.lang.String getUrl()

setUrl

public void setUrl(java.lang.String url)

isDefaultEntry

public boolean isDefaultEntry()

setDefaultEntry

public void setDefaultEntry(boolean defaultEntry)

getCookies

public java.lang.String getCookies()

getPixelPerDegree

public double getPixelPerDegree()

getMaxZoom

public int getMaxZoom()

getMinZoom

public int getMinZoom()

getEulaAcceptanceRequired

public java.lang.String getEulaAcceptanceRequired()

setEulaAcceptanceRequired

public void setEulaAcceptanceRequired(java.lang.String eulaAcceptanceRequired)

getCountryCode

public java.lang.String getCountryCode()

setCountryCode

public void setCountryCode(java.lang.String countryCode)

getIcon

public java.lang.String getIcon()

setIcon

public void setIcon(java.lang.String icon)

getServerProjections

public java.util.List<java.lang.String> getServerProjections()
Get the projections supported by the server. Only relevant for WMS-type ImageryInfo at the moment.

Returns:
null, if no projections have been specified; the list of supported projections otherwise.

setServerProjections

public void setServerProjections(java.util.Collection<java.lang.String> serverProjections)

getExtendedUrl

public java.lang.String getExtendedUrl()

getToolbarName

public java.lang.String getToolbarName()

getMenuName

public java.lang.String getMenuName()

hasAttribution

public boolean hasAttribution()

copyAttribution

public void copyAttribution(ImageryInfo i)

setAttribution

public void setAttribution(AbstractTileSource s)
Applies the attribution from this object to a TMSTileSource.


getImageryType

public ImageryInfo.ImageryType getImageryType()

setImageryType

public void setImageryType(ImageryInfo.ImageryType imageryType)

isBlacklisted

public boolean isBlacklisted()
Returns true if this layer's URL is matched by one of the regular expressions kept by the current OsmApi instance.



JOSM