Building an importer - Revision history

Mheiland at 01:52, 27 June 2009

2009-06-27T01:52:58Z

← Older revision		Revision as of 01:52, 27 June 2009
Line 50:		Line 50:


	[[Category:OX6 ~~related~~]]		[[Category:OX6]]

Mheiland at 01:52, 27 June 2009

2009-06-27T01:52:02Z

← Older revision		Revision as of 01:52, 27 June 2009
Line 50:		Line 50:


	[[Category:~~OX EE related]]~~		[[Category:OX6 related]]
	~~[[Category:OX HE related]]~~
	~~[[Category:OX Hyperion~~ related]]

Tierlieb: added categories

2007-06-26T09:55:28Z

added categories

← Older revision		Revision as of 09:55, 26 June 2007
Line 47:		Line 47:

	Yep, this is Spring [http://www.springframework.org/]. Now you know what you need those <code>spring-core.jar</code> and <code>spring-beans.jar</code> thingies for.		Yep, this is Spring [http://www.springframework.org/]. Now you know what you need those <code>spring-core.jar</code> and <code>spring-beans.jar</code> thingies for.



			[[Category:OX EE related]]
			[[Category:OX HE related]]
			[[Category:OX Hyperion related]]

Tierlieb: /* Plugging the new Importer in */

2007-03-23T15:21:25Z

Plugging the new Importer in

← Older revision		Revision as of 15:21, 23 March 2007
Line 43:		Line 43:
	<bean id="vCardImporter" class="com.openexchange.groupware.importexport.importers.VCardImporter" />		<bean id="vCardImporter" class="com.openexchange.groupware.importexport.importers.VCardImporter" />
	<bean id="csvContactImporter" class="com.openexchange.groupware.importexport.importers.CSVContactImporter" />		<bean id="csvContactImporter" class="com.openexchange.groupware.importexport.importers.CSVContactImporter" />
	~~<bean id="iCalExporter" class="com.openexchange.groupware.importexport.exporters.ICalExporter" />~~
	~~<bean id="vCardExporter" class="com.openexchange.groupware.importexport.exporters.VCardExporter" />~~
	~~<bean id="csvContactExporter" class="com.openexchange.groupware.importexport.exporters.CSVContactExporter" />~~
	<!-- add your class here -->		<!-- add your class here -->
	</beans>		</beans>

	Yep, this is Spring [http://www.springframework.org/]. Now you know what you need those <code>spring-core.jar</code> and <code>spring-beans.jar</code> thingies for.		Yep, this is Spring [http://www.springframework.org/]. Now you know what you need those <code>spring-core.jar</code> and <code>spring-beans.jar</code> thingies for.

Tierlieb: fixed typos

2007-03-23T15:21:04Z

fixed typos

← Older revision		Revision as of 15:21, 23 March 2007
Line 16:		Line 16:
	This method is called by the class which selects an appropriate importer. So make sure to use all your checking here, like		This method is called by the class which selects an appropriate importer. So make sure to use all your checking here, like
	* Is this the format I am responsible for?		* Is this the format I am responsible for?
	* Are the ~~foldesr~~ I am supposed to import into meant for this kind of data? This usually means asking the type of the FolderObject		* Are the folders I am supposed to import into meant for this kind of data? This usually means asking the type of the FolderObject
	* Is this user allowed to write to this folder?		* Is this user allowed to write to this folder?

Line 24:		Line 24:
	* The writers for the database usually hide in <code>com.openexchange.api2</code> and are named *SQLInterface for some strange reason.		* The writers for the database usually hide in <code>com.openexchange.api2</code> and are named *SQLInterface for some strange reason.

	== ~~Pluging~~ the new Importer in ==		== Plugging the new Importer in ==
	As said, open the file <code>importerExporter.xml</code>. After checking out the projects, this should be in the main project at <code>/conf/groupware</code>, if installed, it ought to be somewhere like <code>/opt/open-xchange/groupware</code>.		As said, open the file <code>importerExporter.xml</code>. After checking out the projects, this should be in the main project at <code>/conf/groupware</code>, if installed, it ought to be somewhere like <code>/opt/open-xchange/groupware</code>.
	The file looks like this, just go to the two comment lines and do like people before you did:		The file looks like this, just go to the two comment lines and do like people before you did:

Tierlieb: New page: So, you're not happy with the present importers? You have got data in a format that is not covered by the current selection of importers? No problem, just build one yourself! There are th...

2007-03-19T15:32:49Z

New page: So, you're not happy with the present importers? You have got data in a format that is not covered by the current selection of importers? No problem, just build one yourself! There are th...

New page

So, you're not happy with the present importers? You have got data in a format that is not covered by the current selection of importers? No problem, just build one yourself!

There are three steps to complete to write an importer.
* Defining a new format in <code>com.openexchange.groupware.importexport.Format</code>
* Write an importer by implementing the <code>com.openexchange.groupware.importexport.Importer</code> interface.
* Plug the importer into the file <code>/conf/groupware/importerExporter.xml</code>

== A new format ==
Now this should be easy: Open the file, write a new enum with a different identifier and you are done.
In case you want to extend an existing format (CSV comes to mind) to import something different than Contacts (which currently is the only use for it), you do not need to define a new format.

== Implementing Importer Interface ==
For the most current information, have a look the JavaDoc for the Importer Interface. Here are just two notes:

=== canImport ===
This method is called by the class which selects an appropriate importer. So make sure to use all your checking here, like
* Is this the format I am responsible for?
* Are the foldesr I am supposed to import into meant for this kind of data? This usually means asking the type of the FolderObject
* Is this user allowed to write to this folder?

=== importData ===
This methods does the import (you guessed that). I'd recommend that it internally calls canImport to be sure. The main job consists of writing the data into the folder. This usually is done by creating containing objects and writing them to the database. We got interfaces for that, of course:
* The objects are found in <code>com.openexchange.groupware.container</code> and end with *Object.
* The writers for the database usually hide in <code>com.openexchange.api2</code> and are named *SQLInterface for some strange reason.

== Pluging the new Importer in ==
As said, open the file <code>importerExporter.xml</code>. After checking out the projects, this should be in the main project at <code>/conf/groupware</code>, if installed, it ought to be somewhere like <code>/opt/open-xchange/groupware</code>.
The file looks like this, just go to the two comment lines and do like people before you did:

<beans>
<bean id="importerExporter" class="com.openexchange.groupware.importexport.ImporterExporter">
<property name="importers">
<list>
<ref bean="iCalImporter" />
<ref bean="vCardImporter" />
<ref bean="csvContactImporter" />

</list>
</property>
</bean>

<bean id="iCalImporter" class="com.openexchange.groupware.importexport.importers.ICalImporter" />
<bean id="vCardImporter" class="com.openexchange.groupware.importexport.importers.VCardImporter" />
<bean id="csvContactImporter" class="com.openexchange.groupware.importexport.importers.CSVContactImporter" />
<bean id="iCalExporter" class="com.openexchange.groupware.importexport.exporters.ICalExporter" />
<bean id="vCardExporter" class="com.openexchange.groupware.importexport.exporters.VCardExporter" />
<bean id="csvContactExporter" class="com.openexchange.groupware.importexport.exporters.CSVContactExporter" />

</beans>

Yep, this is Spring [http://www.springframework.org/]. Now you know what you need those <code>spring-core.jar</code> and <code>spring-beans.jar</code> thingies for.