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