+Show TOC
×Hide TOC

RecordSet

Kind of class:	public class
Package:	com.bourre.collection
Inherits from:	none
Implements:	Iterable
Author:	Francis Bourre
Classpath:	com.bourre.collection.RecordSet
File last modified:	Monday, 24 November 2008, 11:36:49

► 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.
 */
package com.bourre.collection 
{
    import com.bourre.error.IllegalArgumentException;    
    import com.bourre.log.PixlibDebug;
    import com.bourre.log.PixlibStringifier;    

    /**
     * @author Francis Bourre
     */
    public class   RecordSet 
        implements Iterable
    {
        protected var _aColumNames     : Array;
        protected var _aItems         : Array;

        public function RecordSet ( rawData : *  )
        {
            parseRawData( rawData );
        }

        public function clear () : void
        {
            _aColumNames = new Array( );
            _aItems = new Array( );
        }

        public function parseRawData ( rawData : *  ) : void
        {
            clear( );
            
            _aColumNames = rawData.serverInfo.columnNames;
    
            var aItems : Array = rawData.serverInfo.initialData;
            var i : Iterator = new ArrayIterator( aItems );
            while( i.hasNext( )) 
            {
                var item : Object = new Object( );
                var aProperties : Array = i.next( );
                
                var j : Iterator = new ArrayIterator( aProperties );
                var n : int = 0 ;
                while( j.hasNext( )) 
                {
                    // TODO: know if * or Object
                    var propertyValue : * = j.next( );
                    var propertyName : String = _aColumNames[ n++ ];
                    
                    item[ propertyName ] = propertyValue;
                }
                
                _aItems.push( item );
            }
        }

        public function getColumnNames () : Array 
        {
            return _aColumNames;
        }

        public function getItems () : Array
        {
            return _aItems;
        }

        public function getItemAt ( n : Number ) : Object
        {
            if ( isEmpty( ) )
            {
                PixlibDebug.WARN( this + ".getItemAt(" + n + ") can't retrieve data, collection is empty." );
                return null;

            } else if ( n < 0 || n >= getLength( ) ) 
            {
                var msg : String = this + ".getItemAt() was used with invalid value :'" + n + "', " + this + ".getLength() equals '" + getLength( ) + "'";
                PixlibDebug.ERROR( msg );
                throw new IllegalArgumentException( msg );
                
                return null;

            } else
            {
                return _aItems[ n ];
            }
        }

        public function isEmpty () : Boolean
        {
            return _aItems.length == 0;
        }

        public function columnIterator ( ) : Iterator 
        {
            return new ArrayIterator( getColumnNames( ) );
        }

        public function iterator () : Iterator
        {
            return new ArrayIterator( getItems( ) );
        }

        public function getLength () : Number
        {
            return _aItems.length;
        }

        /**
         * Returns the string representation of this instance.
         * 
         * @return the string representation of this instance
         */
        public function toString () : String 
        {
            return PixlibStringifier.stringify( this ) + 'column[' + getColumnNames( ) + '] values[' + getItems( ) + ']' ; 
        }
    }
}

Summary

Constructor

RecordSet (rawData:*)

Instance methods

clear : void
parseRawData (rawData:*) : void
getColumnNames : Array
getItems : Array
getItemAt (n:Number) : Object
isEmpty : Boolean
columnIterator : Iterator
iterator : Iterator
- Returns an iterator over the elements in this collection.
getLength : Number
toString : String
- Returns the string representation of this instance.

Constructor

RecordSet

public function RecordSet (

rawData:*)

Instance methods

clear

public function clear (

) : void

columnIterator

public function columnIterator (

) : Iterator

getColumnNames

public function getColumnNames (

) : Array

getItemAt

public function getItemAt (

n:Number) : Object

getItems

public function getItems (

) : Array

getLength

public function getLength (

) : Number

isEmpty

public function isEmpty (

) : Boolean

iterator

public function iterator (

) : Iterator

Returns an iterator over the elements in this collection. There are no
guarantees concerning the order in which the elements are returned
(unless this collection is an instance of some class that provides a
guarantee).

Returns:

an {VISDOC_CODE_BLOCK_2} over the elements in this collection
#

Specified by:

Iterable.iterator

parseRawData

public function parseRawData (

rawData:*) : void

toString

public function toString (

) : String

Returns the string representation of this instance.

Returns:

the string representation of this instance