DefaultJpaCompassGps.java

/*
 * Copyright 2004-2009 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.compass.gps.device.jpa.embedded;

import org.compass.core.Compass;
import org.compass.gps.device.jpa.JpaGpsDevice;
import org.compass.gps.impl.SingleCompassGps;

/**
 * An extension of {@link org.compass.gps.impl.SingleCompassGps} allows to directly
 * get the {@link org.compass.gps.device.jpa.JpaGpsDevice} associted with this Gps.
 *
 * @author kimchy
 */
public class DefaultJpaCompassGps extends SingleCompassGps implements JpaCompassGps {

    public static final String JPA_DEVICE_NAME = "jpa";

    public DefaultJpaCompassGps() {
    }

    public DefaultJpaCompassGps(Compass compass) {
        super(compass);
    }

    /**
     * Returns the Jps Gps device associated with this Compass Gps. The device is
     * registered under {@link #JPA_DEVICE_NAME}.
     */
    public JpaGpsDevice getJpaGpsDevice() {
        return (JpaGpsDevice) getGpsDevice(JPA_DEVICE_NAME);
    }
}