+Show TOC
×Hide TOC

AbstractLocator

Kind of class:	public class
Package:	com.bourre.core
Inherits from:	none
Implements:	Locator TypedContainer
Known subclasses:	ChannelListenerExpert ConstructorExpert FrontController GraphicLoaderLocator MethodExpert ModelLocator PropertyExpert ServiceLocator SoundLoaderLocator SoundMixerLocator TypedFactoryLocator ViewLocator
Classpath:	com.bourre.core.AbstractLocator
File last modified:	Tuesday, 15 April 2008, 09:25:42

► View source

▼ Hide source

package com.bourre.core 
{
    /*
     * 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.
     */

    /**
     * @author Francis Bourre
     * @version 1.0
     */
    import flash.events.Event;
    import flash.utils.Dictionary;
    
    import com.bourre.collection.HashMap;
    import com.bourre.collection.TypedContainer;
    import com.bourre.core.Locator;
    import com.bourre.error.IllegalArgumentException;
    import com.bourre.error.NoSuchElementException;
    import com.bourre.events.Broadcaster;
    import com.bourre.events.EventBroadcaster;
    import com.bourre.log.Log;
    import com.bourre.log.PixlibDebug;
    import com.bourre.log.PixlibStringifier;    

    public class AbstractLocator 
        implements Locator, TypedContainer
    {
        /**
         * Map storing <code>String</code> keys associated with
         * <code>Object</code> values.
         */
        protected var _m : HashMap;

        private var _oEB : Broadcaster;

        private var _cType : Class;
        
        private var _logger : Log;

        /**
         * Creates a new locator instance. If the <code>type</code>
         * argument is defined, the locator is considered as typed, and
         * then the type of all elements inserted in this set is checked.
         * 
         * @param    type <code>Class</code> type for elements of this set
         * @param    type <code>Class</code> type for elements of this set
         */
        public function AbstractLocator( type : Class = null, typeListener : Class = null, logger : Log = null ) 
        {
            _cType = ( type != null ) ? type : Object;
            _m = new HashMap();
            _oEB = new EventBroadcaster( this, typeListener );
            _logger = (logger == null ) ? PixlibDebug.getInstance() : logger;
        }

        protected function onRegister( name : String = null, o : Object = null ) : void
        {
            // override me if you need me
        }

        protected function onUnregister( name : String = null ) : void
        {
            // override me if you need me
        }
        
        protected function broadcastEvent( e : Event ) : void
        {
            _oEB.broadcastEvent( e );
        }
        
        protected function getBroadcaster() : Broadcaster
        {
            return _oEB;
        }

        /**
         * Returns the exclusive logger object owned by this locator.
         * It allow this logger to send logging message directly on
         * its owner logging channel.
         * 
         * @return    logger associated to the owner
         */
        public function getLogger() : Log
        {
            return _logger;
        }

        /**
         * Returns <code>true</code> is there is a ressource associated
         * with the passed-in <code>key</code>. To avoid errors when
         * retreiving ressources from a locator you should systematically
         * use the <code>isRegistered</code> function to check if the
         * ressource you would access is already accessible before any
         * call to the <code>locate</code> function.
         * 
         * @return     <code>true</code> is there is a ressource associated
         *             with the passed-in <code>key</code>.
         */
        public function isRegistered( name : String ) : Boolean
        {
            return _m.containsKey( name );
        }

        public function register( name : String, o : Object ) : Boolean
        {
            var msg : String;

            if ( isTyped() && !( o is getType() ) )
            {
                msg = this + ".register() failed. Item must be '" + getType().toString() + "' typed.";
                getLogger().error ( msg );
                throw new IllegalArgumentException( msg );
            }

            if ( _m.containsKey( name ) )
            {
                msg = " item is already registered with '" + name + "' name in " + this;
                getLogger().error ( msg );
                throw new IllegalArgumentException( msg );

                return false;

            } else
            {
                _m.put( name, o );
                onRegister( name, o );
                return true;
            }
        }

        public function unregister( name : String ) : Boolean
        {
            if ( isRegistered( name ) )
            {
                _m.remove( name );
                onUnregister( name );
                return true;

            } else
            {
                return false;
            }
        }

        /**
         * Returns the ressource associated with the passed-in <code>key</code>.
         * If there is no ressource identified by the passed-in key, the
         * function will fail with an error. To avoid the throw of an exception
         * when attempting to access to a ressource, take care to check the
         * existence of the ressource before trying to access to it.
         * 
         * @param    key    identifier of the ressource to access
         * @return    the ressource associated with the passed-in <code>key</code>
         * @throws     <code>NoSuchElementException</code> ‚Äî There is no ressource
         *             associated with the passed-in key
         */
        public function locate( name : String ) : Object
        {
            if ( isRegistered( name ) ) 
            {
                return _m.get( name );

            } else
            {
                var msg : String = "Can't find '" + getType().toString() + "' item with '" + name + "' name in " + this;
                getLogger().fatal ( msg );
                throw new NoSuchElementException( msg );
            }
        }

        /**
         * Clears all association between keys and objects
         * registered for this locator.
         */
        public function release() : void
        {
            _m.clear();
            _logger = null ;
        }

        /**
         * Adds all ressources contained in the passed-in dictionnary
         * into this locator instance. If there is keys used both in
         * the locator and in the dictionnary an exception is thrown.
         * 
         * @param    d    dictionnary instance which contains ressources
         *                 to be added
         * @throws     <code>IllegalArgumentException</code> ‚Äî One or more
         *             keys present in the dictionnary already exist in this
         *             locator instance.
         */
        public function add( d : Dictionary ) : void
        {
            for ( var key : * in d ) 
            {
                try
                {
                    register( key, d[ key ] );

                } catch ( e : IllegalArgumentException )
                {
                    e.message = this + ".add() fails. " + e.message;
                    _logger.error ( e.message );
                    throw( e );
                }
            }
        }

        /**
         * Verify that the passed-in object type match the current 
         * container element's type. 
         * 
         * @return  <code>true</code> if the object is elligible for this
         *             container, either <code>false</code>.
         */
        public function matchType( o : * ) : Boolean
        {
            return o is _cType || o == null;
        }

        /**
         * Return the class type of elements in this container.
         * <p>
         * An untyped container returns <code>null</code>, as the
         * wildcard type (<code>*</code>) is not a <code>Class</code>
         * and <code>Object</code> class doesn't fit for primitive types.
         * </p>
         * @return <code>Class</code> type of the container's elements
         */
        public function getType() : Class
        {
            return _cType;
        }

        /**
         * Returns <code>true</code> if this container perform a verification
         * of the type of elements.
         * 
         * @return  <code>true</code> if this container perform a verification
         *             of the type of elements.
         */
        public function isTyped() : Boolean
        {
            return _cType != null;
        }

        /**
         * Adds an event listener for the specified event type.
         * There is two behaviors for the <code>addEventListener</code>
         * function : 
         * <ol>
         * <li>The passed-in listener is an object : 
         * The object is added as listener only for the specified event, the object must
         * have a function with the same name than <code>type</code> or at least a
         * <code>handleEvent</code> function.</li>
         * <li>The passed-in listener is a function : 
         * A <code>Delegate</code> object is created and then
         * added as listener for the event type. There is no restriction on the name of 
         * the function. If the <code>rest</code> is not empty, all elements in it is 
         * used as additional arguments into the delegate object. 
         * </ol>
         * 
         * @param    type        name of the event for which register the listener
         * @param    listener    object or function which will receive this event
         * @param    rest        additional arguments for the function listener
         * @return    <code>true</code> if the function have been succesfully added as
         *             listener fot the passed-in event
         * @throws     <code>UnsupportedOperationException</code> ‚Äî If the listener is an object
         *             which have neither a function with the same name than the event type nor
         *             a function called <code>handleEvent</code>
         */
        public function addEventListener( type : String, listener : Object, ... rest ) : Boolean
        {
            return _oEB.addEventListener.apply( _oEB, rest.length > 0 ? [ type, listener ].concat( rest ) : [ type, listener ] );
        }

        /**
         * Removes the passed-in listener for listening the specified event. The
         * listener could be either an object or a function.
         * 
         * @param    type        name of the event for which unregister the listener
         * @param    listener    object or function to be unregistered
         * @return    <code>true</code> if the listener have been successfully removed
         *             as listener for the passed-in event
         */
        public function removeEventListener( type : String, listener : Object ) : Boolean
        {
            return _oEB.removeEventListener( type, listener );
        }
        
        /**
         * Returns an <code>Array</code> view of the keys contained in this locator.
         *
         * @return an array view of the keys contained in this locator
         */
        public function getKeys() : Array
        {
            return _m.getKeys();
        }

        /**
         * Returns an <code>Array</code> view of the values contained in this locator.
         *
         * @return an array view of the values contained in this locator
         */
        public function getValues() : Array
        {
            return _m.getValues();
        }

        /**
         * Returns the string representation of this instance.
         * @return the string representation of this instance
         */
        public function toString () : String
        {
            var hasType : Boolean = getType() != null;
            var parameter : String = "";

            if ( hasType )
            {
                parameter = getType().toString();
                parameter = "<" + parameter.substr( 7, parameter.length - 8 ) + ">";
            }

            return PixlibStringifier.stringify( this ) + parameter;
        }
    }
}

Summary

Constructor

AbstractLocator (type:Class = null, typeListener:Class = null, logger:Log = null)
- Creates a new locator instance.

Instance methods

getLogger : Log
- Returns the exclusive logger object owned by this locator.
isRegistered (name:String) : Boolean
- Returns true is there is a ressource associated
register (name:String, o:Object) : Boolean
unregister (name:String) : Boolean
locate (name:String) : Object
- Returns the ressource associated with the passed-in key.
release : void
- Clears all association between keys and objects
add (d:Dictionary) : void
- Adds all ressources contained in the passed-in dictionnary
matchType (o:*) : Boolean
- Verify that the passed-in object type match the current
getType : Class
- Return the class type of elements in this container.
isTyped : Boolean
- Returns true if this container perform a verification
addEventListener (type:String, listener:Object, rest) : Boolean
- Adds an event listener for the specified event type.
removeEventListener (type:String, listener:Object) : Boolean
- Removes the passed-in listener for listening the specified event.
getKeys : Array
- Returns an Array view of the keys contained in this locator.
getValues : Array
- Returns an Array view of the values contained in this locator.
toString : String
- Returns the string representation of this instance.

Constructor

AbstractLocator

public function AbstractLocator (

type:Class = null, typeListener:Class = null, logger:Log = null)

Creates a new locator instance. If the typeargument is defined, the locator is considered as typed, and
then the type of all elements inserted in this set is checked.

Parameters:

type:

Class type for elements of this set

type:

Class type for elements of this set

Instance methods

add

public function add (

d:Dictionary) : void

Adds all ressources contained in the passed-in dictionnary
into this locator instance. If there is keys used both in
the locator and in the dictionnary an exception is thrown.

Parameters:

dictionnary instance which contains ressources
to be added

Throws:

{VISDOC_LINK_0}IllegalArgumentException — One or more
keys present in the dictionnary already exist in this
locator instance.

Specified by:

Locator.add

addEventListener

public function addEventListener (

type:String, listener:Object, rest) : Boolean

Adds an event listener for the specified event type.
There is two behaviors for the addEventListenerfunction :

The passed-in listener is an object :
The object is added as listener only for the specified event, the object must
have a function with the same name than type or at least a

handleEvent function.
The passed-in listener is a function :
A Delegate object is created and then
added as listener for the event type. There is no restriction on the name of
the function. If the rest is not empty, all elements in it is
used as additional arguments into the delegate object.

Parameters:

type :

name of the event for which register the listener

listener:

object or function which will receive this event

rest :

additional arguments for the function listener

Returns:

true if the function have been succesfully added as
listener fot the passed-in event

Throws:

{VISDOC_LINK_0}UnsupportedOperationException — If the listener is an object
which have neither a function with the same name than the event type nor
a function called handleEvent

getKeys

public function getKeys (

) : Array

Returns an Array view of the keys contained in this locator.

Returns:

an array view of the keys contained in this locator

Specified by:

Locator.getKeys

getLogger

public function getLogger (

) : Log

Returns the exclusive logger object owned by this locator.
It allow this logger to send logging message directly on
its owner logging channel.

Returns:

logger associated to the owner

getType

public function getType (

) : Class

Return the class type of elements in this container.

An untyped container returns null, as the
wildcard type (*) is not a Classand Object class doesn't fit for primitive types.

Returns:

Class type of the container's elements

Specified by:

TypedContainer.getType

getValues

public function getValues (

) : Array

Returns an Array view of the values contained in this locator.

Returns:

an array view of the values contained in this locator

isRegistered

public function isRegistered (

name:String) : Boolean

Returns true is there is a ressource associated
with the passed-in key. To avoid errors when
retreiving ressources from a locator you should systematically
use the isRegistered function to check if the
ressource you would access is already accessible before any
call to the locate function.

Returns:

true is there is a ressource associated
with the passed-in key.

isTyped

public function isTyped (

) : Boolean

Returns true if this container perform a verification
of the type of elements.

Returns:

true if this container perform a verification
of the type of elements.

Specified by:

TypedContainer.isTyped

locate

public function locate (

name:String) : Object

Returns the ressource associated with the passed-in key.
If there is no ressource identified by the passed-in key, the
function will fail with an error. To avoid the throw of an exception
when attempting to access to a ressource, take care to check the
existence of the ressource before trying to access to it.

Parameters:

key:

identifier of the ressource to access

Returns:

the ressource associated with the passed-in key

Throws:

{VISDOC_LINK_0}NoSuchElementException — There is no ressource
associated with the passed-in key

matchType

public function matchType (

o:*) : Boolean

Verify that the passed-in object type match the current
container element's type.

Returns:

true if the object is elligible for this
container, either false.

Specified by:

TypedContainer.matchType

register

public function register (

name:String, o:Object) : Boolean

release

public function release (

) : void

Clears all association between keys and objects
registered for this locator.

removeEventListener

public function removeEventListener (

type:String, listener:Object) : Boolean

Removes the passed-in listener for listening the specified event. The
listener could be either an object or a function.

Parameters:

type :

name of the event for which unregister the listener

listener:

object or function to be unregistered

Returns:

true if the listener have been successfully removed
as listener for the passed-in event

toString

public function toString (

) : String

Returns the string representation of this instance.

Returns:

the string representation of this instance

unregister

public function unregister (

name:String) : Boolean