SurveyedLocale.java

/*
 * Copyright (C) 2010-2016 Stichting Akvo (Akvo Foundation)
 *
 *  This file is part of Akvo Flow.
 *
 *  Akvo Flow is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  Akvo Flow is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with Akvo Flow.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.akvo.flow.domain;

import android.content.Context;
import android.text.TextUtils;

import com.google.android.gms.maps.model.LatLng;
import com.google.maps.android.clustering.ClusterItem;

import org.akvo.flow.R;

import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.Serializable;
import java.util.List;

public class SurveyedLocale implements Serializable, ClusterItem {

    private static final long serialVersionUID = -3556354410813212814L;

    private String mId;
    private String mName;
    private long mLastModified;
    private long mSurveyGroupId;
    private Double mLatitude;
    private Double mLongitude;
    private transient LatLng mLatLng;// This var won't be serialized, just recreated with the lat/lon values
    private List<SurveyInstance> mSurveyInstances = null;

    public SurveyedLocale(String id, String name, long lastModified, long surveyGroupId,
            Double latitude, Double longitude) {
        mId = id;
        mName = name;
        mLastModified = lastModified;
        mSurveyGroupId = surveyGroupId;
        mLatitude = latitude;
        mLongitude = longitude;
        if (latitude != null && longitude != null) {
            mLatLng = new LatLng(latitude, longitude);
        }
    }

    @Override
    public LatLng getPosition() {
        return mLatLng;
    }

    public long getSurveyGroupId() {
        return mSurveyGroupId;
    }

    public long getLastModified() {
        return mLastModified;
    }

    public String getId() {
        return mId;
    }

    public Double getLatitude() {
        return mLatitude;
    }

    public Double getLongitude() {
        return mLongitude;
    }

    public void setSurveyInstances(List<SurveyInstance> surveyInstances) {
        mSurveyInstances = surveyInstances;
    }

    public List<SurveyInstance> getSurveyInstances() {
        return mSurveyInstances;
    }

    public String getName() {
        return mName;
    }

    /**
     * Since LatLng cannot be (automatically) serialized, we'll just populate it with the
     * denormalized lat/lon
     */
    private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException {
        in.defaultReadObject();
        if (mLatitude != null && mLongitude != null) {
            mLatLng = new LatLng(mLatitude, mLongitude);
        }
    }

    /**
     * Get record name if exists, 'Unknown' otherwise
     */
    public String getDisplayName(Context context) {
        return TextUtils.isEmpty(mName) ? context.getString(R.string.unknown) : mName;
    }
}