Base TypeExporter class. More...
Inheritance diagram for sparksee.TypeExporter:
Public Member Functions | |
| def | run (self) |
| Runs export process. More... | |
| def | set_type (self, type) |
| Sets the type to be exported. More... | |
| def | set_header (self, header) |
| Sets the presence of a header row. More... | |
| def | set_row_writer (self, rw) |
| Sets the output data destination. More... | |
| def | set_graph (self, graph) |
| Sets the graph that will be exported. More... | |
| def | register (self, tel) |
| Registers a new listener. More... | |
| def | set_attributes (self, attrs) |
| Sets the list of Attributes. More... | |
| def | set_frequency (self, freq) |
| Sets the frequency of listener notification. More... | |
Detailed Description
Base TypeExporter class.
Base class to export a node or edge type from a graph using a RowWriter.
TypeExporterListener can be registered to receive information about the progress of the export process by means of TypeExporterEvent. The default frequency of notification to listeners is 100000.
By default no header row is created.
Check out the 'Data export' section in the SPARKSEE User Manual for more details on this.
Member Function Documentation
| def sparksee.TypeExporter.register | ( | self, | |
| tel | |||
| ) |
Registers a new listener.
- Parameters
-
tel [in] TypeExporterListener to be registered.
| def sparksee.TypeExporter.run | ( | self | ) |
Runs export process.
- Exceptions
-
RuntimeError null IOError If bad things happen writing to the RowWriter.
| def sparksee.TypeExporter.set_attributes | ( | self, | |
| attrs | |||
| ) |
Sets the list of Attributes.
- Parameters
-
attrs [in] Attribute identifiers to be exported
| def sparksee.TypeExporter.set_frequency | ( | self, | |
| freq | |||
| ) |
Sets the frequency of listener notification.
- Parameters
-
freq [in] Frequency in number of rows managed to notify progress to all listeners
| def sparksee.TypeExporter.set_graph | ( | self, | |
| graph | |||
| ) |
Sets the graph that will be exported.
- Parameters
-
graph [in] Graph.
| def sparksee.TypeExporter.set_header | ( | self, | |
| header | |||
| ) |
Sets the presence of a header row.
- Parameters
-
header [in] If TRUE, a header row is dumped with the name of the attributes.
| def sparksee.TypeExporter.set_row_writer | ( | self, | |
| rw | |||
| ) |
Sets the output data destination.
- Parameters
-
rw [in] Input RowWriter.
| def sparksee.TypeExporter.set_type | ( | self, | |
| type | |||
| ) |
Sets the type to be exported.
- Parameters
-
type [in] Type identifier.
