Packageflare.data.converters
Interfacepublic interface IDataConverter
ImplementorsDelimitedTextConverter, GraphMLConverter, JSONConverter

Interface for data converters that map between an external data file format and ActionScript objects (e.g., Arrays and Objects).



Public Methods
 MethodDefined by
  
read(input:IDataInput, schema:DataSchema = null):DataSet
Converts data from an external format into ActionScript objects.
IDataConverter
  
write(data:DataSet, output:IDataOutput = null):IDataOutput
Converts data from ActionScript objects into an external format.
IDataConverter
Method detail
read()method
public function read(input:IDataInput, schema:DataSchema = null):DataSet

Converts data from an external format into ActionScript objects.

Parameters
input:IDataInput — the loaded input data
 
schema:DataSchema (default = null) — a data schema describing the structure of the data. Schemas are optional in many but not all cases.

Returns
DataSet — a DataSet instance containing converted data objects.
write()method 
public function write(data:DataSet, output:IDataOutput = null):IDataOutput

Converts data from ActionScript objects into an external format.

Parameters
data:DataSet — the data set to write.
 
output:IDataOutput (default = null) — an object to which to write the output. If this value is null, a new ByteArray will be created.

Returns
IDataOutput — the converted data. If the output parameter is non-null, it is returned. Otherwise the return value will be a newly created ByteArray