TreeHouse: Implementing the Data Model in Build an Interacti

// TreeHouse: Implementing the Data Model in Build an Interactive Story App

// 1st, create some packages to keep things organized:
// Create new subpackage. RightClickonPackage>NewPackage> name it UI
// RightClickonPackage>NewPackage> name it model



//-------------------------------------------------------------------------------------------------------------------------------------
Page.java
package teamtreehouse.com.interactivestory.model;


public class Page {
// We said we would have an image, some story text, and two button choices.

    private int mImageId *1*; // Image: We're gonna store our images in our drawable directories, and we will be able to reference them by their ids which are ints.

    private String mText *2*; // Story Text

    // Remember that we said for simplicity, each page will contain two Choices.
    private Choice mChoice1 *3*;
    private Choice mChoice2 *4*;

    // a boolean flag to let us know we are on our last steps**
    private boolean mIsFinal = false;


    // Custom Constructor: *
    //  Why use custom constructor? https://teamtreehouse.com/forum/i-am-completely-confused-with-this-customer-constructor-concepts-in-this-current-tutorial
    public Page(int imageId *1*, String text *2*, Choice choice1 *3*, Choice choice2 *4*) {      // a constructor declaration looks like a method declaration—except that they use the name of the class and has no return type.
        mImageId = imageId; *1*
        mText = text; *2*
        mChoice1 = choice1; *3*
        mChoice2 = choice2; *4*
    }

    // Page 5 and Page 6 end up now where because they are at the end of the story.
    // So we remove the choices and add create a new constructor of null choices.
    // Simple:
    public Page(int imageId, String text) {
        mImageId = imageId;
        mText = text;
        mChoice1 = null;
        mChoice2 = null;
        mIsFinal = true; **

    }

    //Getter for Boolean Final **
    public boolean isFinal() {
        return mIsFinal;
    }

    //Setter for Boolean Final **
    public void setFinal(boolean isFinal) {
        mIsFinal = isFinal;
    }


// Okay, so we have all the data we need in private member variables, but
// we don't have any way to get and set this data.
// We need Getter and Setter methods.
// Now, you may be aware of this pattern from Java, but, if not, we add a pair of
// methods for each member variable, one to get it, and one to set it.

// Now this work about getters and setters may seem tedious or overkill.
// The thing to remember is that it's a good practice that lets us control the details
// behind the scenes of these objects,
// which can prove invaluable when making future changes.


    // So let's do that first for image id:
    public int getImageId() {
        return mImageId;
    }

    // for Text method
    public String getText() {
        return mText;
    }

    // for Choice1
    public Choice getChoice1() {
        return mChoice1;
    }

    // for Choice 2
    public Choice getChoice2() {
        return mChoice2;
    }
}

//-------------------------------------------------------------------------------------------------------------------------------------

// There are different ways we can represent this choice, but let's add another class.
Choice.java


package teamtreehouse.com.interactivestory.model;

// Custom Constructor *
public class Choice {
    private String mText; // Text that describe the choice
    private int mNextPage; // We're going to use the index of the pages in the array to link one to another.

    public Choice(String text, int nextPage) {
        mText = text;
        mNextPage = nextPage;
    }

    // getter
    public String getText() {
        return mText;
    }

    // setter
    public void setText(String text) {
        mText = text;
    }

    public int getNextPage() {
        return mNextPage;
    }

    public void setNextPage(int nextPage) {
        mNextPage = nextPage;
    }
}
//------------------------------------------------------------------------------------------------------------------------------------
// 2nd, create Arrays so you can pull pages out of arrays (much cleaner):



package teamtreehouse.com.interactivestory.model;

    // Okay, anyhow, we need to now add our story data to this array.
    // Hm, what should we do here?
    // How about we initialize our array, mPages, in onCreate.
    // So let's add a couple lines.
    // And say mPages equals a new array of Pages and we'll give it a size of seven.
    // We have seven story pages in this version of the story.
    mPages = new Page[7];

public class Story {
    private Page[] mPages;


    public Story() {                //method to initialize our story:
        mPages = new Page[7];


        mPages[0] = new Page(
        //Wondering why this is formatted this way? Because we used our own Custom Constructor *
                R.drawable.page0,
                "On your return trip from studying Saturn's rings, you hear a distress signal that seems to be coming from the surface of Mars. It's strange because there hasn't been a colony there in years. Even stranger, it's calling you by name: \"Help me, %1$s, you're my only hope.\"",
                new Choice("Stop and investigate", 1),
                new Choice("Continue home to Earth", 2));

        mPages[1] = new Page(
                R.drawable.page1,
                "You deftly land your ship near where the distress signal originated. You didn't notice anything strange on your fly-by, but there is a cave in front of you. Behind you is an abandoned rover from the early 21st century.",
                new Choice("Explore the cave", 3),
                new Choice("Explore the rover", 4));

        mPages[2] = new Page(
                R.drawable.page2,
                "You continue your course to Earth. Two days later, you receive a transmission from HQ saying that they have detected some sort of anomaly on the surface of Mars near an abandoned rover. They ask you to investigate, but ultimately the decision is yours because your mission has already run much longer than planned and supplies are low.",
                new Choice("Head back to Mars to investigate", 4),
                new Choice("Continue home to Earth", 6));

        mPages[3] = new Page(
                R.drawable.page3,
                "Your EVA suit is equipped with a headlamp, which you use to navigate the cave. After searching for a while your oxygen levels are starting to get pretty low. You know you should go refill your tank, but there's a very faint light up ahead.",
                new Choice("Refill at ship and explore the rover", 4),
                new Choice("Continue towards the faint light", 5));

        mPages[4] = new Page(
                R.drawable.page4,
                "The rover is covered in dust and most of the solar panels are broken. But you are quite surprised to see the on-board system booted up and running. In fact, there is a message on the screen: \"%1$s, come to 28.543436, -81.369031.\" Those coordinates aren't far, but you don't know if your oxygen will last there and back.",
                new Choice("Explore the coordinates", 5),
                new Choice("Return to Earth", 6));

        mPages[5] = new Page(
                R.drawable.page5,
                "After a long walk slightly uphill, you end up at the top of a small crater. You look around, and are overjoyed to see your favorite android, %1$s-S1124. It had been lost on a previous mission to Mars! You take it back to your ship and fly back to Earth.");

        mPages[6] = new Page(
                R.drawable.page6,
                "You arrive home on Earth. While your mission was a success, you forever wonder what was sending that signal. Perhaps a future mission will be able to investigate...");
    }

    public Page getPage(int pageNumber) {
        return mPages[pageNumber];
    }
}



//---------------------------------------------------------------------------------------------------------------------------------

// Constructors explained:
// http://stackoverflow.com/questions/19061599/methods-vs-constructors-in-java
// https://teamtreehouse.com/library/build-an-interactive-story-app/the-modelviewcontroller-pattern/implementing-the-data-model