001 package biweekly.property;
002
003 import java.util.List;
004
005 import biweekly.Warning;
006 import biweekly.component.ICalComponent;
007
008 /*
009 Copyright (c) 2013, Michael Angstadt
010 All rights reserved.
011
012 Redistribution and use in source and binary forms, with or without
013 modification, are permitted provided that the following conditions are met:
014
015 1. Redistributions of source code must retain the above copyright notice, this
016 list of conditions and the following disclaimer.
017 2. Redistributions in binary form must reproduce the above copyright notice,
018 this list of conditions and the following disclaimer in the documentation
019 and/or other materials provided with the distribution.
020
021 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
022 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
023 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
024 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
025 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
026 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
027 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
028 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
029 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
030 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
031 */
032
033 /**
034 * <p>
035 * Defines a set of geographical coordinates.
036 * </p>
037 * <p>
038 * <b>Examples:</b>
039 *
040 * <pre class="brush:java">
041 * Geo geo = new Geo(40.714623, -74.006605);
042 * </pre>
043 *
044 * </p>
045 * @author Michael Angstadt
046 * @rfc 5545 p.85-7
047 */
048 public class Geo extends ICalProperty {
049 private Double latitude;
050 private Double longitude;
051
052 /**
053 * Creates a new geo property.
054 * @param latitude the latitude
055 * @param longitude the longitude
056 */
057 public Geo(Double latitude, Double longitude) {
058 this.latitude = latitude;
059 this.longitude = longitude;
060 }
061
062 /**
063 * Gets the latitude.
064 * @return the latitude
065 */
066 public Double getLatitude() {
067 return latitude;
068 }
069
070 /**
071 * Sets the latitude.
072 * @param latitude the latitude
073 */
074 public void setLatitude(Double latitude) {
075 this.latitude = latitude;
076 }
077
078 /**
079 * Gets the longitude.
080 * @return the longitude
081 */
082 public Double getLongitude() {
083 return longitude;
084 }
085
086 /**
087 * Sets the longitude.
088 * @param longitude the longitude
089 */
090 public void setLongitude(Double longitude) {
091 this.longitude = longitude;
092 }
093
094 /**
095 * Converts a coordinate in the degrees-minutes-seconds format into its
096 * decimal equivalent.
097 * @param degrees the degrees
098 * @param minutes the minutes
099 * @param seconds the seconds
100 * @return the decimal value
101 */
102 public static double toDecimal(int degrees, int minutes, int seconds) {
103 return degrees + (minutes / 60.0) + (seconds / 3600.0);
104 }
105
106 @Override
107 protected void validate(List<ICalComponent> components, List<Warning> warnings) {
108 if (latitude == null) {
109 warnings.add(Warning.validate(41));
110 }
111 if (longitude == null) {
112 warnings.add(Warning.validate(42));
113 }
114 }
115 }