Packagecom.yworks.io.graphml.reader
Interfacepublic interface IInputHandler
Implementors AbstractInputHandler, AttributeInputHandler, AutoMapperAttributeInputHandler, CompatResourceInputHandler, SharedDataInputHandler

Basic interface for data handlers that parse data sections with a specific key and scope. Data Handlers can be added to a GraphMLIOHandler instance.

See also

com.yworks.io.graphml.GraphMLIOHandler.addDataHandler

Public Methods
 MethodDefined By
  
acceptKey(keyElement:XML, scopeType:String):Boolean
Whether this data handler can parse a data section with the given key and scope type.
IInputHandler
  
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.
IInputHandler
  
parseData(context:GraphMLParseContext, defaultValue:Boolean, dataElement:XML):void
This method is invoked each time a data element with matching key is processed.
IInputHandler
  
parseDefaultData(context:GraphMLParseContext, keyElement:XML):Object
This method is invoked when the default value of the key element for a data tag is parsed.
IInputHandler
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 — he default xml element.
 
value:Object — the parsed value of the default element

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:Boolean — true 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.




Wed Oct 7 2015, 04:52 PM +02:00