+Show TOC
×Hide TOC

SGrid

Kind of class:	class
Inherits from:	AbstractGrid
Version:	1.0
Author:	Francis Bourre
Classpath:	com.bourre.structures.SGrid
File last modified:	Wednesday, 31 October 2007, 07:35:30

► View source

▼ Hide source

/*
 * Copyright the original author or authors.
 * 
 * Licensed under the MOZILLA PUBLIC LICENSE, Version 1.1 (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.mozilla.org/MPL/MPL-1.1.html
 * 
 * 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.
 */
 
/**
 * {@code SGrid} defines {@code String} grid structure.
 * 
 * <p>Based on {@link AbstractGrid} class, this data's structure only accept 
 * {@code String} element for content.
 * 
 * @author Francis Bourre
 * @version 1.0
 */
 
import com.bourre.log.PixlibDebug;
import com.bourre.log.PixlibStringifier;
import com.bourre.structures.AbstractGrid;
import com.bourre.structures.Point;

class com.bourre.structures.SGrid extends AbstractGrid
{
    //-------------------------------------------------------------------------
    // Public API
    //-------------------------------------------------------------------------
    
    /**
     * Constructs a new {@code SGrid} instance.
     * 
     * <p>Example
     * <code>
     *   var g : SGrid = new SGrid(2, 2);
     * </code>
     * 
     * @param nX grid width
     * @param nY grid height
     */
    public function SGrid (nX:Number, nY:Number) 
    {
        super(nX, nY);
    }
    
    /**
     * Returns value stored in grid cell defining by 
     * passed-in {@link Point} coordinate.
     * 
     * <p>Concrete implementation of {@link AbstractGrid#getVal} method.
     * 
     * <p>Example
     * <code>
     *   var g : SGrid = new SGrid(2, 2);
     *   var aElements : Array = new Array("chair", "room", "tree", "carpet");
     *   g.setContent(aElements};
     *   
     *   var r : String = g.getVal( new Point(0,1) ); //return "tree"
     * </code>
     * 
     * @param v Cell {@link Point} position
     * 
     * @return {@code String} value
     */
    public function getVal(v:Point) : String
    {
        checkGridCoords(v);
        return _aContent[v.x][v.y];
    }
    
    /**
     * Defines value of grid cell defining by passed-in {@link Point} 
     * coordinate.
     * 
     * <p>Concrete implementation of {@link AbstractGrid#setVal} method.
     * 
     * <p>Example
     * <code>
     *   var g : SGrid = new SGrid(2, 2);
     *   var aElements : Array = new Array("chair", "room", "tree", "carpet");
     *   g.setContent(aElements};
     *   g.setVal( new Point(0,1), "plant");
     *   
     *   var r : Number = b.getVal( new Point(0,1) ); //return "plant"
     * </code>
     * 
     * @param v Cell {@link Point} position
     */
    public function setVal(v:Point, s:String) : Void
    {
        checkGridCoords(v);
        _aContent[v.x][v.y] = s; 
    }
    
    /**
     * Permutes 2 passed-in {@code cell} value.
     * 
     * <p>Example
     * <code>
     *   var g : SGrid = new SGrid(2, 2);
     *   var aElements : Array = new Array("chair", "room", "tree");
     *   g.setContent(aElements);
     *   PixlibDebug.DEBUG( g.serialize() ); //return "chair,room,tree,_"
     * 
     *   g.permute( new Point(0,1), new Point(1,0) );
     *   PixlibDebug.DEBUG( g.serialize() ); //return "chair,tree,room,_"
     * </code>
     * 
     * @param v1 First cell {@link Point} position
     * @param v1 Second cell {@link Point} position
     */
    public function permute(v1:Point, v2:Point) : Void
    {
        var s1:String = getVal(v1);
        setVal(v1, getVal(v2));
        setVal(v2, s1);
    }
    
    /**
     * Serializes grid content.
     * 
     * <p>Useful to save grid content.
     * 
     * <p>Use {@link #deserialize} to load content.
     * 
     * <p>Example
     * <code>
     *   var g : SGrid = new SGrid(2, 2);
     *   var aElements : Array = new Array("chair", "room", "tree");
     *   g.setContent(aElements); 
     *   
     *   PixlibDebug.DEBUG( g.serialize() ); //return "chair,room,tree,_"
     *   PixlibDebug.DEBUG( g.serialize("|", "__") ); //return "chair|room|tree|__"
     * </code>  
     * 
     * @param sCharSep {@code String} separator value (default ",");
     * @param sUndefined {@code String} used for {@code undefined} or {@code null} 
     * value in grid. (default "_")
     * 
     * @return Serialization {@code String} 
     */
    public function serialize(sCharSep:String, sUndefined:String) : String
    {
        sCharSep = (sCharSep == undefined) ? "," : sCharSep;
        sUndefined = (sUndefined == undefined) ? "_" : sUndefined;
        var s:String = "";
        
        var i = getIterator();
        while(i.hasNext())
        {
            var w:String = i.next();
            s += ( w == undefined ) ? sUndefined + sCharSep : w + sCharSep;
        }
        return s.substr(0, s.length - sCharSep.length);
    }
    
    /**
     * Deserializes passed-in {@code String} content and 
     * loads it into grid.
     * 
     * <p>Useful to load grid content.
     * 
     * <p>Use {@link #serialize} to save content.
     * 
     * <p>Example
     * <code>
     *   var b : SGrid = new SGrid(2, 2);
     *   var sContent : String = "chair|room|tree|__";
     *   
     *   b.deserialize(sContent, "|", "__");
     * </code>
     * 
     * @param s Content {@code String} representation
     * @param sCharSep {@code String} separator value (default ",");
     * @param sUndefined {@code String} used for {@code undefined} or {@code null} 
     * value in grid. (default "_")
     */
    public function deserialize(s:String, sCharSep:String, sUndefined:String) : Void
    {
        sCharSep = (sCharSep == undefined) ? "," : sCharSep;
        sUndefined = (sUndefined == undefined) ? "_" : sUndefined;
        
        var a:Array = s.split(sCharSep);
        setContent(a, sUndefined);
    }
    
    /**
     * Sets content of grid with passed-in {@code Array} of String objects.
     * 
     * <p>Can use {@link #deserialize} method to define content directly with a 
     * {@code String} representation content like "chair,room,tree,_"
     * 
     * <p>Used by {@link deserialize} to load content after deserialization process.
     * 
     * <p>Example
     * <code>
     *   var g : SGrid = new SGrid(2, 2);
     *   var aContent : Array = new Array("chair","room","tree","_");
     *   g.setContent(aContent);
     * </code>
     * 
     * @param a {@code Array} structure of {@code String} elements.
     * @param sUndefined {@code String} used for {@code undefined} or {@code null} 
     * value in grid.
     */
    public function setContent(a:Array, sUndefined:String) : Void
    {
        if (a.length != getArea()) PixlibDebug.ERROR( "Array size mismatches with SGrid size!" );
        
        var s:String;
        var i = getIterator();
        
        while (i.hasNext())
        {
            i.next();
            s = a[i.getIndex()];
            if (s != sUndefined) setVal(i, s);
        }
    }
    
    /**
     * Returns the string representation of this instance.
     * @return the string representation of this instance
     */
    public function toString() : String 
    {
        return PixlibStringifier.stringify( this );
    }
}

SGrid defines String grid structure.

Based on AbstractGrid class, this data's structure only accept
String element for content.

Summary

Constructor

SGrid

Instance properties

Instance properties inherited from AbstractGrid

_aContent _vSize getVal setVal

Instance methods

getVal
setVal
permute
serialize
deserialize
setContent
toString

Instance methods inherited from AbstractGrid

_fillWith checkGridCoords getArea getArrayRange getCloneRange getColumn getCoordinates getIntFromVector getIterator getRandomCoords getRow getSize initContent isGridCoords searchForAll searchForOne toString

Constructor

SGrid

function SGrid (

nX:Number, nY:Number)

Constructs a new SGrid instance.

Example

var g : SGrid = new SGrid(2, 2);

Parameters:

nX:

grid width

nY:

grid height

Instance methods

deserialize

function deserialize (

s:String, sCharSep:String, sUndefined:String) : Void

Deserializes passed-in String content and
loads it into grid.

Useful to load grid content.

Use serialize to save content.

Example

var b : SGrid = new SGrid(2, 2);
var sContent : String = "chair|room|tree|__";

b.deserialize(sContent, "|", "__");

Parameters:

s :

Content String representation

sCharSep :

String separator value (default ",");

sUndefined:

String used for undefined or null
value in grid. (default "_")

getVal

function getVal (

v:Point) : String

Returns value stored in grid cell defining by
passed-in Point coordinate.

Concrete implementation of AbstractGrid.getVal method.

Example

var g : SGrid = new SGrid(2, 2);
var aElements : Array = new Array("chair", "room", "tree", "carpet");
g.setContent(aElements};

var r : String = g.getVal( new Point(0,1) ); //return "tree"

Parameters:

Cell Point position

Returns:

String value

permute

function permute (

v1:Point, v2:Point) : Void

Permutes 2 passed-in cell value.

Example

var g : SGrid = new SGrid(2, 2);
var aElements : Array = new Array("chair", "room", "tree");
g.setContent(aElements);
PixlibDebug.DEBUG( g.serialize() ); //return "chair,room,tree,_"

g.permute( new Point(0,1), new Point(1,0) );
PixlibDebug.DEBUG( g.serialize() ); //return "chair,tree,room,_"

Parameters:

v1:

First cell Point position

v1:

Second cell Point position

serialize

function serialize (

sCharSep:String, sUndefined:String) : String

Serializes grid content.

Useful to save grid content.

Use deserialize to load content.

Example

var g : SGrid = new SGrid(2, 2);
var aElements : Array = new Array("chair", "room", "tree");
g.setContent(aElements); 

PixlibDebug.DEBUG( g.serialize() ); //return "chair,room,tree,_"
PixlibDebug.DEBUG( g.serialize("|", "__") ); //return "chair|room|tree|__"

Parameters:

sCharSep :

String separator value (default ",");

sUndefined:

String used for undefined or null
value in grid. (default "_")

Returns:

Serialization String

setContent

function setContent (

a:Array, sUndefined:String) : Void

Sets content of grid with passed-in Array of String objects.

Can use deserialize method to define content directly with a
String representation content like "chair,room,tree,_"

Used by deserialize to load content after deserialization process.

Example

var g : SGrid = new SGrid(2, 2);
var aContent : Array = new Array("chair","room","tree","_");
g.setContent(aContent);

Parameters:

a :

Array structure of String elements.

sUndefined:

String used for undefined or null
value in grid.

setVal

function setVal (

v:Point, s:String) : Void

Defines value of grid cell defining by passed-in Point
coordinate.

Concrete implementation of AbstractGrid.setVal method.

Example

var g : SGrid = new SGrid(2, 2);
var aElements : Array = new Array("chair", "room", "tree", "carpet");
g.setContent(aElements};
g.setVal( new Point(0,1), "plant");

var r : Number = b.getVal( new Point(0,1) ); //return "plant"

Parameters:

Cell Point position

toString

function toString (

) : String

Returns the string representation of this instance.

Returns:

the string representation of this instance

Overrides:

AbstractGrid.toString