AndroidUserDictionary.java

/*
 * Copyright (c) 2013 Menny Even-Danan
 *
 * 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.anysoftkeyboard.dictionaries.content;

import android.content.ContentResolver;
import android.content.ContentValues;
import android.content.Context;
import android.database.ContentObserver;
import android.database.Cursor;
import android.net.Uri;
import android.provider.UserDictionary.Words;
import android.text.TextUtils;
import com.anysoftkeyboard.dictionaries.BTreeDictionary;
import com.anysoftkeyboard.dictionaries.WordsCursor;
import com.anysoftkeyboard.utils.Log;

public class AndroidUserDictionary extends BTreeDictionary {

    private static final String[] PROJECTION = {Words._ID, Words.WORD, Words.FREQUENCY};
    private final String mLocale;

    public AndroidUserDictionary(Context context, String locale) {
        super("AndroidUserDictionary", context);
        mLocale = locale;
    }

    @Override
    protected void registerObserver(ContentObserver dictionaryContentObserver, ContentResolver contentResolver) {
        contentResolver.registerContentObserver(Words.CONTENT_URI, false, dictionaryContentObserver);
    }

    public WordsCursor getWordsCursor() {
        Cursor cursor = TextUtils.isEmpty(mLocale) ?
                mContext.getContentResolver().query(Words.CONTENT_URI, PROJECTION, "(" + Words.LOCALE + " IS NULL)", null, null) :
                mContext.getContentResolver().query(Words.CONTENT_URI, PROJECTION, "(" + Words.LOCALE + " IS NULL) or (" + Words.LOCALE + "=?)", new String[]{mLocale}, null);

        if (cursor == null) throw new RuntimeException("No built-in Android dictionary!");

        return new WordsCursor(cursor);
    }

    @Override
    protected void AddWordToStorage(String word, int frequency) {
        if (TextUtils.isEmpty(word)) {
            return;
        }

        if (frequency < 1) frequency = 1;
        if (frequency > 255) frequency = 255;

        ContentValues values = new ContentValues(4);
        values.put(Words.WORD, word);
        values.put(Words.FREQUENCY, frequency);
        values.put(Words.LOCALE, mLocale);
        values.put(Words.APP_ID, 0); // TODO: Get App UID

        Uri result = mContext.getContentResolver().insert(Words.CONTENT_URI, values);
        Log.i(TAG, "Added the word '" + word + "' at locale " + mLocale + " into Android's user dictionary. Result " + result);
    }

    @Override
    protected final void deleteWordFromStorage(String word) {
        mContext.getContentResolver().delete(Words.CONTENT_URI, Words.WORD + "=?", new String[]{word});
    }

    @Override
    public String toString() {
        return mLocale + "@" + super.toString();
    }

    @Override
    protected void closeStorage() {
        /*nothing to close here*/
    }
}