summaryrefslogtreecommitdiffstats
path: root/tests/LocationTracker/src/com/google/android/locationtracker/data/TrackerDataHelper.java
blob: cdcc2b334112231a1169f4252aa2384aa636b240 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
/*
 * Copyright (C) 2008 Google Inc.
 *
 * 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 com.google.android.locationtracker.data;

import android.content.Context;
import android.database.Cursor;
import android.location.Location;

/**
 * Helper class for writing and retrieving data using the TrackerProvider
 * content provider
 *
 */
public class TrackerDataHelper {

    private Context mContext;
    /** formats data output */
    protected IFormatter mFormatter;

    /** formats output as Comma separated value CSV file */
    public static final IFormatter CSV_FORMATTER = new CSVFormatter();
    /** formats output as KML file */
    public static final IFormatter KML_FORMATTER = new KMLFormatter();
    /** provides no formatting */
    public static final IFormatter NO_FORMATTER = new IFormatter() {
        public String getFooter() {
            return "";
        }

        public String getHeader() {
            return "";
        }

        public String getOutput(TrackerEntry entry) {
            return "";
        }
    };

    /**
     * Creates instance
     *
     * @param context - content context
     * @param formatter - formats the output from the get*Output* methods
     */
    public TrackerDataHelper(Context context, IFormatter formatter) {
        mContext = context;
        mFormatter = formatter;
    }

    /**
     * Creates a instance with no output formatting capabilities. Useful for
     * clients that require write-only access
     */
    public TrackerDataHelper(Context context) {
        this(context, NO_FORMATTER);
    }

    /**
     * insert given TrackerEntry into content provider
     */
    void writeEntry(TrackerEntry entry) {
        mContext.getContentResolver().insert(TrackerProvider.CONTENT_URI,
                entry.getAsContentValues());
    }

    /**
     * insert given location into tracker data
     */
    public void writeEntry(Location loc, float distFromNetLoc) {
        writeEntry(TrackerEntry.createEntry(loc, distFromNetLoc));
    }

    /**
     * insert given log message into tracker data
     */
    public void writeEntry(String tag, String logMsg) {
        writeEntry(TrackerEntry.createEntry(tag, logMsg));
    }

    /**
     * Deletes all tracker entries
     */
    public void deleteAll() {
        mContext.getContentResolver().delete(TrackerProvider.CONTENT_URI, null,
                null);
    }

    /**
     * Query tracker data, filtering by given tag
     *
     * @param tag
     * @return Cursor to data
     */
    public Cursor query(String tag, int limit) {
        String selection = (tag == null ? null : TrackerEntry.TAG + "=?");
        String[] selectionArgs = (tag == null ? null : new String[] {tag});
        Cursor cursor = mContext.getContentResolver().query(
                TrackerProvider.CONTENT_URI, TrackerEntry.ATTRIBUTES,
                selection, selectionArgs, null);
        if (cursor == null) {
            return cursor;
        }
        int pos = (cursor.getCount() < limit ? 0 : cursor.getCount() - limit);
        cursor.moveToPosition(pos);
        return cursor;
    }

    /**
     * Retrieves a cursor that starts at the last limit rows
     *
     * @param limit
     * @return a cursor, null if bad things happened
     */
    public Cursor query(int limit) {
        return query(null, limit);
    }

    /**
     * Query tracker data, filtering by given tag. mo limit to number of rows
     * returned
     *
     * @param tag
     * @return Cursor to data
     */
    public Cursor query(String tag) {
        return query(tag, Integer.MAX_VALUE);
    }

    /**
     * Returns the output header particular to the associated formatter
     */
    public String getOutputHeader() {
        return mFormatter.getHeader();
    }

    /**
     * Returns the output footer particular to the associated formatter
     */
    public String getOutputFooter() {
        return mFormatter.getFooter();
    }

    /**
     * Helper method which converts row referenced by given cursor to a string
     * output
     *
     * @param cursor
     * @return CharSequence output, null if given cursor is invalid or no more
     *         data
     */
    public String getNextOutput(Cursor cursor) {
        if (cursor == null || cursor.isAfterLast()) {
            return null;
        }
        String output = mFormatter.getOutput(TrackerEntry.createEntry(cursor));
        cursor.moveToNext();
        return output;
    }
}