NMEASentenceFactory.java

/*******************************************************************************
 * Copyright (c) 2008, 2009 Bug Labs, Inc.
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *    - Redistributions of source code must retain the above copyright notice,
 *      this list of conditions and the following disclaimer.
 *    - Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *    - Neither the name of Bug Labs, Inc. nor the names of its contributors may be
 *      used to endorse or promote products derived from this software without
 *      specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *******************************************************************************/
package com.buglabs.nmea2;

import com.buglabs.nmea.sentences.NMEAParserException;

/**
 * This factory will return a valid NMEA object based on a NMEA string, or null
 * if no match is available.
 * 
 * @author kgilmer
 * 
 */
public class NMEASentenceFactory {
	/**
	 * An array of supported message types.
	 */
	public static final String[] SENTENCE_TYPES = { "$PTTK", "$GPGGA", "$GPRMC", "$GPGSV" };

	/**
	 * @param gpsData
	 * @return A Concrete NMEA object or null if there is no match.
	 * @throws NMEAParserException
	 */
	public static AbstractNMEASentence getSentence(String gpsData) throws NMEAParserException {
		if (gpsData == null) {
			throw new NMEAParserException("Input data is NULL.");
		}

		try {

			if (gpsData.startsWith(SENTENCE_TYPES[0])) {
				return new PTTK(gpsData);
			}

			if (gpsData.startsWith(SENTENCE_TYPES[1])) {
				return new GGA(gpsData);
			}

			if (gpsData.startsWith(SENTENCE_TYPES[2])) {
				return new RMC(gpsData);
			}

			if (gpsData.startsWith(SENTENCE_TYPES[3])) {
				return new GSV(gpsData);
			}
		} catch (RuntimeException e) {
			//Convert unchecked exceptions into parse exceptions.
			throw new NMEAParserException("Runtime exception occurred: " + e.getMessage(), e);
		}

		return null;
	}
}