Packagecom.yworks.io.graphml.reader
Classpublic class AttributeInputHandler
ImplementsIInputHandler
SubclassesMapperAttributeInputHandler, MapperRegistryAttributeInputHandler

A data handler that stores attributes given as data elements in graphml files into an IGraphDataHandler.



Public Properties
 PropertyDefined by
  attributeName : String
[read-only] The attribute name
AttributeInputHandler
Protected Properties
 PropertyDefined by
  _attributeFactory : IAttributeFactory
The IAttributeFactory to store parsed values in.
AttributeInputHandler
  _attributeName : String
The attribute name
AttributeInputHandler
  _defaultValue : String
The default value to use.
AttributeInputHandler
Public Methods
 MethodDefined by
  
AttributeInputHandler(attrName:String, scopeType:String, attributeFactory:IAttributeFactory)
Creates a new input handler for a given attribute.
AttributeInputHandler
  
acceptKey(keyElement:XML, scopeType:String):Boolean
Whether this data handler can parse a data section with the given key and scope type.
AttributeInputHandler
  
applyDefault(context:GraphMLParseContext, defaultElement:XML, value:Object):void
This method is invoked when no data tag is defined, and the default value should be applied.
AttributeInputHandler
  
parseData(context:GraphMLParseContext, defaultValue:Boolean, dataElement:XML):void
This method is invoked each time a data element with matching key is processed.
AttributeInputHandler
  
parseDefaultData(context:GraphMLParseContext, keyElement:XML):Object
This method is invoked when the default value of the key element for a data tag is parsed.
AttributeInputHandler
Property detail
_attributeFactoryproperty
protected var _attributeFactory:IAttributeFactory

The IAttributeFactory to store parsed values in.

_attributeNameproperty 
protected var _attributeName:String

The attribute name

attributeNameproperty 
attributeName:String  [read-only]

The attribute name

Implementation
    public function get attributeName():String
_defaultValueproperty 
protected var _defaultValue:String

The default value to use.

Constructor detail
AttributeInputHandler()constructor
public function AttributeInputHandler(attrName:String, scopeType:String, attributeFactory:IAttributeFactory)

Creates a new input handler for a given attribute.

Parameters
attrName:String — The value of the attr.name attribute of the <key> element for the attribute this data handler should read.
 
scopeType:String
 
attributeFactory:IAttributeFactory — the scope to accept
Method detail
acceptKey()method
public function acceptKey(keyElement:XML, scopeType:String):Boolean

Whether this data handler can parse a data section with the given key and scope type.

Parameters
keyElement:XML — the xml element which contains the key
 
scopeType:String — the scope type that contains the data section

Returns
Boolean — true if this data can parse a data section with this key and scopeType.
applyDefault()method 
public function applyDefault(context:GraphMLParseContext, defaultElement:XML, value:Object):void

This method is invoked when no data tag is defined, and the default value should be applied.

Parameters
context:GraphMLParseContext — the current parse context.
 
defaultElement:XML
 
value:Object
parseData()method 
public function parseData(context:GraphMLParseContext, defaultValue:Boolean, dataElement:XML):void

This method is invoked each time a data element with matching key is processed. Parse a data element of a graphml file.

Parameters
context:GraphMLParseContext — the parse context
 
defaultValue:Booleantrue when the default value, which is included in the key element, is processed, false otherwise.
 
dataElement:XML — The data element of the graphml file.
parseDefaultData()method 
public function parseDefaultData(context:GraphMLParseContext, keyElement:XML):Object

This method is invoked when the default value of the key element for a data tag is parsed.

Parameters
context:GraphMLParseContext — The current parse context.
 
keyElement:XML — The xml node that represents the key element

Returns
Object — The parsed value of the xml element, may be null.