Detailed Description

Constructor & Destructor Documentation

◆ EdgeTypeExporter()

Member Function Documentation

◆ CanRun()

◆ NotifyListeners()

◆ Register()

◆ Run()

◆ RunProcess()

◆ SetAttributes()

◆ SetFrequency()

◆ SetGraph()

◆ SetHeadAttribute()

◆ SetHeader()

◆ SetHeadPosition()

◆ SetRowWriter()

◆ SetTailAttribute()

◆ SetTailPosition()

◆ SetType()

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ EdgeTypeExporter()

Member Function Documentation

◆ CanRun()

◆ NotifyListeners()

◆ Register()

◆ Run()

◆ RunProcess()

◆ SetAttributes()

◆ SetFrequency()

◆ SetGraph()

◆ SetHeadAttribute()

◆ SetHeader()

◆ SetHeadPosition()

◆ SetRowWriter()

◆ SetTailAttribute()

◆ SetTailPosition()

◆ SetType()

#include <EdgeTypeExporter.h>

Inheritance diagram for EdgeTypeExporter:

Collaboration diagram for EdgeTypeExporter:

Public Member Functions
	EdgeTypeExporter ()
	Creates a new instance.
	EdgeTypeExporter (RowWriter &rowWriter, sparksee::gdb::Graph &graph, sparksee::gdb::type_t type, sparksee::gdb::AttributeList &attrs, sparksee::gdb::int32_t hPos, sparksee::gdb::int32_t tPos, sparksee::gdb::attr_t hAttr, sparksee::gdb::attr_t tAttr)
	Creates a new instance.
virtual	~EdgeTypeExporter ()
	Destructor.
void	Run () throw (sparksee::gdb::IOException, sparksee::gdb::WrongArgumentError, sparksee::gdb::Error)
	See the TypeExporter class Run method.
void	SetHeadAttribute (sparksee::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 (sparksee::gdb::int32_t pos)
	Sets the position (index column) of the head attribute in the exported data.
void	SetTailAttribute (sparksee::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 (sparksee::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 (sparksee::gdb::Graph &graph)
	Sets the graph that will be exported.
void	SetType (sparksee::gdb::type_t type)
	Sets the type to be exported.
void	SetAttributes (sparksee::gdb::AttributeList &attrs)
	Sets the list of Attributes.
void	SetFrequency (sparksee::gdb::int32_t freq)
	Sets the frequency of listener notification.
void	SetHeader (sparksee::gdb::bool_t header)
	Sets the presence of a header row.

Protected Member Functions
sparksee::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 (sparksee::gdb::IOException, sparksee::gdb::WrongArgumentError, sparksee::gdb::Error)
	Runs export process.

EdgeTypeExporter class.

Specific TypeExporter implementation for edge types.

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

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

EdgeTypeExporter::EdgeTypeExporter	(	RowWriter &	rowWriter,
		sparksee::gdb::Graph &	graph,
		sparksee::gdb::type_t	type,
		sparksee::gdb::AttributeList &	attrs,
		sparksee::gdb::int32_t	hPos,
		sparksee::gdb::int32_t	tPos,
		sparksee::gdb::attr_t	hAttr,
		sparksee::gdb::attr_t	tAttr )

inline

Creates a new instance.

Parameters

rowWriter	[in] Output RowWriter.
graph	[in] Graph.
type	[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.

References TypeExporter::SetHeadAttribute(), TypeExporter::SetHeadPosition(), TypeExporter::SetTailAttribute(), TypeExporter::SetTailPosition(), and TypeExporter::TypeExporter().

sparksee::gdb::bool_t TypeExporter::CanRun ( )

protectedinherited

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 )

protectedinherited

Notifies progress to all registered listeners.

Parameters

ev	[in] Progress event to be notified.

void TypeExporter::Register ( TypeExporterListener & tel )

inherited

Registers a new listener.

Parameters

tel	[in] TypeExporterListener to be registered.

References Register().

Referenced by Register().

inlinevirtual

See the TypeExporter class Run method.

Exceptions

IOException	If bad things happen writting to the RowWriter.
WrongArgumentError	In case of bad settings
Error	For other issues

Implements TypeExporter.

protectedinherited

Runs export process.

Exceptions

IOException	If bad things happen writting to the RowWriter.
WrongArgumentError	In case of bad settings
Error	For other issues

void TypeExporter::SetAttributes ( sparksee::gdb::AttributeList & attrs )

inherited

Sets the list of Attributes.

Parameters

attrs [in] Attribute identifiers to be exported

References SetAttributes().

Referenced by SetAttributes().

void TypeExporter::SetFrequency ( sparksee::gdb::int32_t freq )

inherited

Sets the frequency of listener notification.

Parameters

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

References SetFrequency().

Referenced by SetFrequency().

void TypeExporter::SetGraph ( sparksee::gdb::Graph & graph )

inherited

Sets the graph that will be exported.

Parameters

graph [in] Graph.

References SetGraph().

Referenced by SetGraph().

void EdgeTypeExporter::SetHeadAttribute ( sparksee::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

References TypeExporter::SetHeadAttribute().

void TypeExporter::SetHeader ( sparksee::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.

References END_SPARKSEE_IO_NAMESPACE, and SetHeader().

Referenced by SetHeader().

void EdgeTypeExporter::SetHeadPosition ( sparksee::gdb::int32_t pos )

inline

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

Parameters

pos	[in] Head position

References TypeExporter::SetHeadPosition().

void TypeExporter::SetRowWriter ( RowWriter & rw )

inherited

Sets the output data destination.

Parameters

rw	[in] Input RowWriter.

References SetRowWriter().

Referenced by SetRowWriter().

void EdgeTypeExporter::SetTailAttribute ( sparksee::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

References TypeExporter::SetTailAttribute().

void EdgeTypeExporter::SetTailPosition ( sparksee::gdb::int32_t pos )

inline

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

Parameters

pos	[in] Tail position

References TypeExporter::SetTailPosition().

void TypeExporter::SetType ( sparksee::gdb::type_t type )

inherited

Sets the type to be exported.

Parameters

type	[in] Type identifier.

References SetType().

Referenced by SetType().

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

EdgeTypeExporter.h

void EdgeTypeExporter::Run

sparksee::gdb::IOException,

sparksee::gdb::WrongArgumentError,

sparksee::gdb::Error )