Packageorg.pranaframework.ioc.factory.xml.parser
Classpublic class XmlObjectDefinitionsParser

Xml parser for object definitions.



Public Properties
 PropertyDefined by
  objectFactory : XmlObjectFactory
XmlObjectDefinitionsParser
Public Methods
 MethodDefined by
  
Constructs a new XmlObjectDefinitionsParser.
XmlObjectDefinitionsParser
  
Adds a preprocessor to the parser.
XmlObjectDefinitionsParser
  
parse(xml:XML, properties:ArrayCollection = null):XmlObjectFactory
Parses all object definitions and returns the container that contains the parsed results.
XmlObjectDefinitionsParser
  
parseArray(node:XML):Array
Parses an array
XmlObjectDefinitionsParser
  
parseArrayCollection(node:XML):ArrayCollection
Parses an ArrayCollection
XmlObjectDefinitionsParser
  
parseDictionary(dictionaryNode:XML):Dictionary
Parses a Dictionary
XmlObjectDefinitionsParser
  
parseObject(node:XML):Object
Parses an object
XmlObjectDefinitionsParser
  
XmlObjectDefinitionsParser
Public Constants
 ConstantDefined by
  ARRAY_COLLECTION_ELEMENT : String = "array-collection"
[static]
XmlObjectDefinitionsParser
  ARRAY_ELEMENT : String = "array"
[static]
XmlObjectDefinitionsParser
  CLASS_ATTRIBUTE : String = "class"
[static]
XmlObjectDefinitionsParser
  CONSTRUCTOR_ARG_ELEMENT : String = "constructor-arg"
[static]
XmlObjectDefinitionsParser
  DICTIONARY_ELEMENT : String = "dictionary"
[static]
XmlObjectDefinitionsParser
  ENTRY_ELEMENENT : String = "entry"
[static]
XmlObjectDefinitionsParser
  FACTORY_METHOD_ATTRIBUTE : String = "factory-method"
[static]
XmlObjectDefinitionsParser
  ID_ATTRIBUTE : String = "id"
[static]
XmlObjectDefinitionsParser
  INIT_METHOD_ATTRIBUTE : String = "init-method"
[static]
XmlObjectDefinitionsParser
  KEY_ATTRIBUTE : String = "key"
[static]
XmlObjectDefinitionsParser
  KEY_ELEMENT : String = "key"
[static]
XmlObjectDefinitionsParser
  LAZY_INIT_ATTRIBUTE : String = "lazy-init"
[static]
XmlObjectDefinitionsParser
  LIST_ELEMENT : String = "list"
[static]
XmlObjectDefinitionsParser
  MAP_ELEMENT : String = "map"
[static]
XmlObjectDefinitionsParser
  OBJECT_ELEMENT : String = "object"
[static]
XmlObjectDefinitionsParser
  PROPERTY_ELEMENT : String = "property"
[static]
XmlObjectDefinitionsParser
  REF_ATTRIBUTE : String = "ref"
[static]
XmlObjectDefinitionsParser
  REF_ELEMENT : String = "ref"
[static]
XmlObjectDefinitionsParser
  SCOPE_ATTRIBUTE : String = "scope"
[static]
XmlObjectDefinitionsParser
  TEMPLATE_ELEMENT : String = "template"
[static]
XmlObjectDefinitionsParser
  VALUE_ATTRIBUTE : String = "value"
[static]
XmlObjectDefinitionsParser
  VALUE_ELEMENT : String = "value"
[static]
XmlObjectDefinitionsParser
Property detail
objectFactoryproperty
objectFactory:XmlObjectFactory  [read-write]Implementation
    public function get objectFactory():XmlObjectFactory
    public function set objectFactory(value:XmlObjectFactory):void
Constructor detail
XmlObjectDefinitionsParser()constructor
public function XmlObjectDefinitionsParser(objectFactory:XmlObjectFactory = null)

Constructs a new XmlObjectDefinitionsParser. An optional container can be passed to store the definitions. If no container is passed then a new one gets created.

Parameters
objectFactory:XmlObjectFactory (default = null) — the container where the definitions will be stored
Method detail
addPreprocessor()method
public function addPreprocessor(preprocessor:IXmlObjectDefinitionsPreprocessor):void

Adds a preprocessor to the parser.

Parameters
preprocessor:IXmlObjectDefinitionsPreprocessor
parse()method 
public function parse(xml:XML, properties:ArrayCollection = null):XmlObjectFactory

Parses all object definitions and returns the container that contains the parsed results.

Parameters
xml:XML — the xml object with the object definitions
 
properties:ArrayCollection (default = null) — a collection of Properties objects

Returns
XmlObjectFactory — the container with the parsed object definitions
parseArray()method 
public function parseArray(node:XML):Array

Parses an array

Parameters
node:XML

Returns
Array
parseArrayCollection()method 
public function parseArrayCollection(node:XML):ArrayCollection

Parses an ArrayCollection

Parameters
node:XML

Returns
ArrayCollection
parseDictionary()method 
public function parseDictionary(dictionaryNode:XML):Dictionary

Parses a Dictionary

Parameters
dictionaryNode:XML

Returns
Dictionary
parseObject()method 
public function parseObject(node:XML):Object

Parses an object

Parameters
node:XML

Returns
Object
parseObjectDefinition()method 
public function parseObjectDefinition(xml:XML):IObjectDefinition

Parameters
xml:XML

Returns
IObjectDefinition
Constant detail
ARRAY_COLLECTION_ELEMENTconstant
public static const ARRAY_COLLECTION_ELEMENT:String = "array-collection"
ARRAY_ELEMENTconstant 
public static const ARRAY_ELEMENT:String = "array"
CLASS_ATTRIBUTEconstant 
public static const CLASS_ATTRIBUTE:String = "class"
CONSTRUCTOR_ARG_ELEMENTconstant 
public static const CONSTRUCTOR_ARG_ELEMENT:String = "constructor-arg"
DICTIONARY_ELEMENTconstant 
public static const DICTIONARY_ELEMENT:String = "dictionary"
ENTRY_ELEMENENTconstant 
public static const ENTRY_ELEMENENT:String = "entry"
FACTORY_METHOD_ATTRIBUTEconstant 
public static const FACTORY_METHOD_ATTRIBUTE:String = "factory-method"
ID_ATTRIBUTEconstant 
public static const ID_ATTRIBUTE:String = "id"
INIT_METHOD_ATTRIBUTEconstant 
public static const INIT_METHOD_ATTRIBUTE:String = "init-method"
KEY_ATTRIBUTEconstant 
public static const KEY_ATTRIBUTE:String = "key"
KEY_ELEMENTconstant 
public static const KEY_ELEMENT:String = "key"
LAZY_INIT_ATTRIBUTEconstant 
public static const LAZY_INIT_ATTRIBUTE:String = "lazy-init"
LIST_ELEMENTconstant 
public static const LIST_ELEMENT:String = "list"
MAP_ELEMENTconstant 
public static const MAP_ELEMENT:String = "map"
OBJECT_ELEMENTconstant 
public static const OBJECT_ELEMENT:String = "object"
PROPERTY_ELEMENTconstant 
public static const PROPERTY_ELEMENT:String = "property"
REF_ATTRIBUTEconstant 
public static const REF_ATTRIBUTE:String = "ref"
REF_ELEMENTconstant 
public static const REF_ELEMENT:String = "ref"
SCOPE_ATTRIBUTEconstant 
public static const SCOPE_ATTRIBUTE:String = "scope"
TEMPLATE_ELEMENTconstant 
public static const TEMPLATE_ELEMENT:String = "template"
VALUE_ATTRIBUTEconstant 
public static const VALUE_ATTRIBUTE:String = "value"
VALUE_ELEMENTconstant 
public static const VALUE_ELEMENT:String = "value"