EdgeTypeExporter Class Reference
[IO]

EdgeTypeExporter class. More...

Inheritance diagram for EdgeTypeExporter:

Inheritance graph
Collaboration diagram for EdgeTypeExporter:

Collaboration graph

List of all members.

Public Member Functions

 EdgeTypeExporter ()
 Creates a new instance.
 EdgeTypeExporter (RowWriter &rw, dex::gdb::Graph &g, dex::gdb::type_t t, dex::gdb::AttributeList &attrs, dex::gdb::int32_t hPos, dex::gdb::int32_t tPos, dex::gdb::attr_t hAttr, dex::gdb::attr_t tAttr)
 Creates a new instance.
virtual ~EdgeTypeExporter ()
 Destructor.
void Run () throw (dex::gdb::IOException, dex::gdb::Error)
 See TypeExporter::Run.
void SetHeadAttribute (dex::gdb::attr_t attr)
 Sets the attribute that will be used to get the value to be dumped for the head of the edge.
void SetHeadPosition (dex::gdb::int32_t pos)
 Sets the position (index column) of the head attribute in the exported data.
void SetTailAttribute (dex::gdb::attr_t attr)
 Sets the attribute that will be used to get the value to be dumped for the tail of the edge.
void SetTailPosition (dex::gdb::int32_t pos)
 Sets the position (index column) of the tail attribute in the exported data.
void Register (TypeExporterListener &tel)
 Registers a new listener.
void SetRowWriter (RowWriter &rw)
 Sets the output data destination.
void SetGraph (dex::gdb::Graph &g)
 Sets the graph that will be exported.
void SetType (dex::gdb::type_t t)
 Sets the type to be exported.
void SetAttributes (dex::gdb::AttributeList &attrs)
 Sets the list of Attributes.
void SetFrequency (dex::gdb::int32_t freq)
 Sets the frequency of listener notification.
void SetHeader (dex::gdb::bool_t header)
 Sets the presence of a header row.

Protected Member Functions

dex::gdb::bool_t CanRun ()
 Checks that all the required settings are ready to run.
void NotifyListeners (const TypeExporterEvent &ev)
 Notifies progress to all registered listeners.
void RunProcess () throw (dex::gdb::IOException, dex::gdb::Error)
 Runs export process.


Detailed Description

EdgeTypeExporter class.

Specific TypeExporter implementation for edge types.

Check out the 'Data export' section in the DEX User Manual for more details on this.

Author:
Sparsity Technologies http://www.sparsity-technologies.com

Constructor & Destructor Documentation

EdgeTypeExporter::EdgeTypeExporter ( RowWriter rw,
dex::gdb::Graph &  g,
dex::gdb::type_t  t,
dex::gdb::AttributeList &  attrs,
dex::gdb::int32_t  hPos,
dex::gdb::int32_t  tPos,
dex::gdb::attr_t  hAttr,
dex::gdb::attr_t  tAttr 
) [inline]

Creates a new instance.

Parameters:
rw [in] Output RowWriter.
g [in] Graph.
t [in] Type identifier.
attrs [in] Attribute identifiers to be exported.
hPos [in] The position (index column) for the head value.
tPos [in] The position (index column) for the tail value.
hAttr [in] The attribute identifier to get the value to be dumped for the head.
tAttr [in] The attribute identifier to get the value to be dumped for the tail.


Member Function Documentation

void EdgeTypeExporter::SetHeadAttribute ( dex::gdb::attr_t  attr  )  [inline]

Sets the attribute that will be used to get the value to be dumped for the head of the edge.

Parameters:
attr [in] Head Attribute

Reimplemented from TypeExporter.

void EdgeTypeExporter::SetHeadPosition ( dex::gdb::int32_t  pos  )  [inline]

Sets the position (index column) of the head attribute in the exported data.

Parameters:
pos [in] Head position

Reimplemented from TypeExporter.

void EdgeTypeExporter::SetTailAttribute ( dex::gdb::attr_t  attr  )  [inline]

Sets the attribute that will be used to get the value to be dumped for the tail of the edge.

Parameters:
attr [in] Tail Attribute

Reimplemented from TypeExporter.

void EdgeTypeExporter::SetTailPosition ( dex::gdb::int32_t  pos  )  [inline]

Sets the position (index column) of the tail attribute in the exported data.

Parameters:
pos [in] Tail position

Reimplemented from TypeExporter.

dex::gdb::bool_t TypeExporter::CanRun (  )  [protected, inherited]

Checks that all the required settings are ready to run.

Returns:
Returns true if all the settings are ready.

void TypeExporter::NotifyListeners ( const TypeExporterEvent ev  )  [protected, inherited]

Notifies progress to all registered listeners.

Parameters:
ev [in] Progress event to be notified.

void TypeExporter::RunProcess (  )  throw (dex::gdb::IOException, dex::gdb::Error) [protected, inherited]

Runs export process.

Exceptions:
IOException If bad things happen writting to the RowWriter.

void TypeExporter::Register ( TypeExporterListener tel  )  [inherited]

Registers a new listener.

Parameters:
tel [in] TypeExporterListener to be registered.

void TypeExporter::SetRowWriter ( RowWriter rw  )  [inherited]

Sets the output data destination.

Parameters:
rr [in] Input RowWriter.

void TypeExporter::SetGraph ( dex::gdb::Graph &  g  )  [inherited]

Sets the graph that will be exported.

Parameters:
g [in] Graph.

void TypeExporter::SetType ( dex::gdb::type_t  t  )  [inherited]

Sets the type to be exported.

Parameters:
t [in] Type identifier.

void TypeExporter::SetAttributes ( dex::gdb::AttributeList &  attrs  )  [inherited]

Sets the list of Attributes.

Parameters:
attrs [in] Attribute identifiers to be exported

void TypeExporter::SetFrequency ( dex::gdb::int32_t  freq  )  [inherited]

Sets the frequency of listener notification.

freq [in] Frequency in number of rows managed to notify progress to all listeners

void TypeExporter::SetHeader ( dex::gdb::bool_t  header  )  [inherited]

Sets the presence of a header row.

Parameters:
header [in] If TRUE, a header row is dumped with the name of the attributes.


The documentation for this class was generated from the following file:

Generated on Tue Jul 16 12:10:16 2013 for Dex by  doxygen 1.5.6