TranslationNote.java

package com.door43.translationstudio.core;

import org.json.JSONException;
import org.json.JSONObject;

/**
 * Represents a translation note
 */
public class TranslationNote {
    private final String mChapterId;
    private final String mFrameId;
    private final String mId;
    private final String title;
    private final String body;

    public TranslationNote(String chapterId, String frameId, String noteId, String title, String body) {
        mChapterId = chapterId;
        mFrameId = frameId;
        mId = noteId;
        this.title = title;
        this.body = body;
    }

    /**
     * Generates a new note from json
     * @param chapterId
     * @param frameId
     * @param json
     * @return
     */
    public static TranslationNote generate(String chapterId, String frameId, JSONObject json) {
        if(json == null) {
            return null;
        }
        try {
            return new TranslationNote(
                    chapterId,
                    frameId,
                    json.getString("id"),
                    json.getString("ref"),
                    json.getString("text"));
        } catch (JSONException e) {
            e.printStackTrace();
        }
        return null;
    }

    /**
     * Returns the id of this note
     * @return
     */
    public String getId() {
        return mId;
    }

    /**
     * Returns the id of the frame in which this note exists
     * @return
     */
    public String getFrameId() {
        return mFrameId;
    }

    /**
     * Returns the id of the chapter in which this note exists
     * @return
     */
    public String getChapterId() {
        return mChapterId;
    }

    /**
     * Returns the title of the translation note
     * @return
     */
    public String getTitle() {
        return title;
    }

    /**
     * Returns the body of the translation note
     * @return
     */
    public String getBody() {
        return body;
    }
}