package com.tyndalehouse.step.core.models;

import org.codehaus.jackson.annotate.JsonIgnore;
import org.crosswire.jsword.passage.Key;

/**
 * Wraps around an OSIS Key
 * 
 * @author chrisburrell
 * 
 */
public class KeyWrapper {
    private String osisKeyId;
    private String name;
    private boolean lastChapter;
    @JsonIgnore
    private Key key;

    /**
     * for use by serialisation
     */
    public KeyWrapper() {
        // for use by serialisation
    }

    /**
     * Initialises a KeyWrapper with its Key
     * 
     * @param k the key
     */
    public KeyWrapper(final Key k) {
        this.key = k;
        this.name = k.getName();
        this.osisKeyId = k.getOsisID();
    }

    /**
     * @return the osisKeyId
     */
    public String getOsisKeyId() {
        return this.osisKeyId;
    }

    /**
     * @param osisKeyId the osisKeyId to set
     */
    public void setOsisKeyId(final String osisKeyId) {
        this.osisKeyId = osisKeyId;
    }

    /**
     * @return the name
     */
    public String getName() {
        return this.name;
    }

    /**
     * @param name the name to set
     */
    public void setName(final String name) {
        this.name = name;
    }

    /**
     * @return the key at the origin of this
     */
    public Key getKey() {
        return key;
    }

    /**
     * WARNING: this is not always set and defaults to 'false'
     * @return true if the key is in the last chapter, not always populated
     */
    public boolean isLastChapter() {
        return lastChapter;
    }

    /**
     * @param lastChapter true to indicate last chapter
     */
    public void setLastChapter(final boolean lastChapter) {
        this.lastChapter = lastChapter;
    }
}