Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.database
Class DbDataImport

java.lang.Object
  extended by com.jivesoftware.util.AbstractPollableRunnable
      extended by com.jivesoftware.forum.database.DbDataImport
All Implemented Interfaces:
PollableRunnable, java.io.Serializable, java.lang.Runnable

public class DbDataImport
extends AbstractPollableRunnable
implements java.io.Serializable

Imports Jive data that is stored in the Jive XML format. The class can handle plain XML files or compressed JAR files. All XML must strictly comply with the Jive XML Schema.

See Also:
Serialized Form

Field Summary
static java.lang.String XML_DATE_FORMAT
           
static java.lang.String XML_VERSION
           
 
Constructor Summary
DbDataImport(ForumFactory forumFactory, java.io.File file)
          Initializes Jive Forum data importer.
 
Method Summary
 void doRun()
          Executes the logic of the task.
 java.io.Reader getReader()
           
 int getTaskValue()
          Returns the current value of the task's progress.
static void main(java.lang.String[] args)
          Usage -username - user to execute importer as -password - password to execute user as -input - xml file to import

jiveHome env property must be set (-DjiveHome=

 void setReader(java.io.Reader reader)
           
 
Methods inherited from class com.jivesoftware.util.AbstractPollableRunnable
cancel, getEndDate, getPercentComplete, getStartDate, getTaskMaximum, getTaskMinimum, isFinished, isIndeterminate, isRunning, run
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

XML_DATE_FORMAT

public static final java.lang.String XML_DATE_FORMAT
See Also:
Constant Field Values

XML_VERSION

public static final java.lang.String XML_VERSION
See Also:
Constant Field Values
Constructor Detail

DbDataImport

public DbDataImport(ForumFactory forumFactory,
                    java.io.File file)
             throws java.lang.Exception
Initializes Jive Forum data importer.

Parameters:
forumFactory - a ForumFactory instance.
Throws:
java.lang.Exception
Method Detail

getTaskValue

public int getTaskValue()
Description copied from interface: PollableRunnable
Returns the current value of the task's progress. This will be x where min <= x <= max. If this is in indeterminate mode then this will return -1.

Specified by:
getTaskValue in interface PollableRunnable
Specified by:
getTaskValue in class AbstractPollableRunnable
Returns:
the current value of the task's progress.

doRun

public void doRun()
Description copied from class: AbstractPollableRunnable
Executes the logic of the task. Errors should be handled by the implementing class as this method does not throw any exceptions.

Specified by:
doRun in class AbstractPollableRunnable

getReader

public java.io.Reader getReader()

setReader

public void setReader(java.io.Reader reader)

main

public static void main(java.lang.String[] args)
Usage -username - user to execute importer as -password - password to execute user as -input - xml file to import

jiveHome env property must be set (-DjiveHome=

Parameters:
args - command line args

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.