Back to project page WordZap.
The source code is released under:
Copyright (c) 2010 Kowshik Prakasam Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal ...
If you think the Android project WordZap listed in this page is inappropriate, such as containing malicious code/tools or violating the copyright, please email info at java2s dot com, thanks.
/** * /* ww w . ja va 2 s .c o m*/ * The MIT License : http://www.opensource.org/licenses/mit-license.php * Copyright (c) 2010 Kowshik Prakasam * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. * */ package com.android.wordzap.datamodel; import java.util.EmptyStackException; import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.Stack; import java.util.Vector; import com.android.wordzap.WordCache; import com.android.wordzap.exceptions.InvalidGridSizeException; import com.android.wordzap.exceptions.InvalidStackOperationException; import com.android.wordzap.exceptions.WordStackOverflowException; /* * Core class that abstracts the data model for the visual grid that the * human player sees on screen Offers an efficient interface to * manipulate the grid of letters * */ public class LetterGrid { private int numRows; private int numCols; private Stack<WordStack> stackOfWords; private WordCache aWordCache; public static final String ROW_KEY = "row"; public static final String COL_KEY = "col"; public static final String LETTER_KEY = "letter"; /* * Negative numRows and numCols cause constructor to throw appropriate * exceptions. */ public LetterGrid(int numRows, int numCols) throws InvalidGridSizeException { if (numRows > 0 && numCols > 0) { this.numRows = numRows; this.numCols = numCols; stackOfWords = new Stack<WordStack>(); } else { throw new InvalidGridSizeException(numRows, numCols); } this.aWordCache = null; } /* * Negative numRows and numCols cause constructor to throw appropriate * exceptions. */ public LetterGrid(int numRows, int numCols, final WordCache aWordCache) throws InvalidGridSizeException { this(numRows, numCols); if (aWordCache == null) { throw new NullPointerException( "The cache object passed cant be null"); } this.aWordCache = aWordCache; } // Getter for WordCache attribute public WordCache getWordCache() { return this.aWordCache; } // Setter for WordCache attribute public void setWordCache(WordCache newCache) { if (newCache == null) { throw new NullPointerException( "The cache object passed cant be null"); } this.aWordCache = newCache; } /* * Returns numRows passed in constructor */ public int getRowLimit() { return this.numRows; } /* * Returns numCols passed in constructor */ public int getColLimit() { return this.numCols; } /* * Pushes a letter to top of grid. * * Note that you need to call unlockWordAtTop() before you can push / pop * letters. * * Returns a Map< String, String > object with information about which row * and col to which the letter was pushed. The Map< String, String > object * will have the following key - value pairs * * * Key : LetterGrid.ROW_KEY Value : Row to which the letter was pushed in * the grid * * * Key : LetterGrid.COL_KEY Value : Col to which the letter was pushed in * the grid * * Key : LetterGrid.LETTER_KEY Value : Letter which was pushed * * Throws WordStackOverflowException : if letter grid overflows. * * Throws InvalidStackOperationException : if word at top of stack is * locked. */ public Map<String, String> putLetter(char letter) throws WordStackOverflowException, InvalidStackOperationException { Map<String, String> map = new HashMap<String, String>(); map.put(LetterGrid.LETTER_KEY, "" + letter); if (stackOfWords.empty()) { this.addNewStack(letter); } else { WordStack latestWordStack = stackOfWords.peek(); if (latestWordStack.isWordComplete()) { if (this.isGridFull()) { throw new WordStackOverflowException(letter, this .getRowLimit()); } this.addNewStack(letter); } else { latestWordStack.pushLetter(letter); } } map.put(LetterGrid.ROW_KEY, "" + (stackOfWords.size() - 1)); map.put(LetterGrid.COL_KEY, "" + (stackOfWords.peek().size() - 1)); return map; } /* * Adds a new stack */ private void addNewStack(char letter) throws WordStackOverflowException, InvalidStackOperationException { WordStack aNewStack; try { aNewStack = new WordStack(numCols); aNewStack.pushLetter(letter); stackOfWords.push(aNewStack); } catch (InvalidGridSizeException ex) { } } /* * Removes letter from top of grid. * * Note that you need to call unlockWordAtTop() before you can push / pop * letters. * * Returns a Map< String, String > object with information about which row * and col from which the letter was popped. The Map< String, String > * object will have the following key - value pairs * * * Key : LetterGrid.ROW_KEY Value : Row from which the letter was popped in * the grid * * * Key : LetterGrid.COL_KEY Value : Col from which the letter was popped in * the grid * * Key : LetterGrid.LETTER_KEY Value : Letter which was popped * * Throws EmptyStackException : if grid is empty, or stack at the top of the * grid is empty. * * Throws InvalidStackOperationException : if stack at the top of the grid * is locked. */ public Map<String, String> popLetter() throws EmptyStackException, InvalidStackOperationException { WordStack stackAtTheTop = stackOfWords.peek(); Map<String, String> map = new HashMap<String, String>(); map.put(LetterGrid.LETTER_KEY, String .valueOf(stackAtTheTop.popLetter())); map.put(LetterGrid.ROW_KEY, String.valueOf(stackOfWords.size() - 1)); map.put(LetterGrid.COL_KEY, String.valueOf(stackAtTheTop.size())); return map; } /* * Returns letter from top of grid. * * Returns a Map< String, String > object with information about which row * and col from which the letter was peeked at. The Map< String, String > * object will have the following key - value pairs * * * Key : LetterGrid.ROW_KEY Value : Row to which the letter was peeked at in * the grid * * * Key : LetterGrid.COL_KEY Value : Col to which the letter was peeked at in * the grid * * Key : LetterGrid.LETTER_KEY Value : Letter which was peeked at. * * Throws EmptyStackException : if grid is empty. */ public Map<String, String> peekLetter() throws EmptyStackException { WordStack stackAtTheTop = stackOfWords.peek(); Map<String, String> map = new HashMap<String, String>(); map.put(LetterGrid.LETTER_KEY, String.valueOf(stackAtTheTop .peekLetter())); map.put(LetterGrid.ROW_KEY, String.valueOf(stackOfWords.size() - 1)); map.put(LetterGrid.COL_KEY, String.valueOf(stackAtTheTop.size() - 1)); return map; } /* * Returns word at top of grid * * Throws EmptyStackException : if grid is empty */ public String getWordAtTop() throws EmptyStackException { WordStack stackAtTheTop = stackOfWords.peek(); return stackAtTheTop.toString(); } /* * Returns List representation of words internally stored in the grid */ public List<String> getWordList() { List<String> wordList = new Vector<String>(); for (WordStack aWordStack : stackOfWords) { wordList.add(aWordStack.toString()); } return wordList; } /* * Returns List representation of completed words internally stored in the * grid */ public List<String> getCompletedWordList() { List<String> wordList = new Vector<String>(); for (WordStack aWordStack : stackOfWords) { if (aWordStack.isWordComplete()) { wordList.add(aWordStack.toString()); } } return wordList; } /* * Clears the grid */ public void clearGrid() { stackOfWords = new Stack<WordStack>(); } /* * Locks word at top of grid. * * Throws EmptyStackException : if grid is empty. * * Throws InvalidStackOperationException : if word at top of grid is empty, * and the user attempts to lock the word. */ public boolean lockWordAtTop() throws InvalidStackOperationException, EmptyStackException { WordStack stackAtTheTop = stackOfWords.peek(); if (this.aWordCache != null && this.aWordCache.isWordValid(stackAtTheTop.toString())) { stackAtTheTop.lockWord(); return true; } return false; } /* * Unlocks word at top of grid. * * You have to call this method before calling putLetter() or popLetter() * methods of the same class. * * Throws EmptyStackException : if grid is empty */ public void unlockWordAtTop() throws EmptyStackException { WordStack stackAtTheTop = stackOfWords.peek(); stackAtTheTop.unlockWord(); } /* * Removes word at the top of the grid * * Throws EmptyStackException : if grid is empty */ public String removeWordAtTop() throws EmptyStackException { return stackOfWords.pop().toString(); } /* * Tells if word at top is locked * * Throws EmptyStackException : if grid is empty */ public boolean isWordLockedAtTop() throws EmptyStackException { return stackOfWords.peek().isWordComplete(); } /* * Tells if the grid contains the specified word */ public boolean containsWord(String word) { for (WordStack aWordStack : stackOfWords) { if (aWordStack.isWordComplete() && aWordStack.toString().equals(word)) { return true; } } return false; } /* * Removes a word from the letter grid */ public int removeWord(String word) { WordStack stackToBeRemoved = null; for (WordStack aWordStack : stackOfWords) { if (aWordStack.isWordComplete() && aWordStack.toString().equals(word)) { stackToBeRemoved = aWordStack; break; } } int wordIndex=stackOfWords.indexOf(stackToBeRemoved); stackOfWords.remove(stackToBeRemoved); return wordIndex; } /* * Tells if the grid is full */ public boolean isGridFull(){ if(this.getCompletedWordList().size() == this.getRowLimit()){ return true; } return false; } }