org.wandora.application.tools.solr

Class SolrIndexBuilder

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.exporters.AbstractExportTool

org.wandora.application.tools.solr.SolrIndexBuilder

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, WandoraTool, WandoraToolLogger, TopicMapLogger

public class SolrIndexBuilder
extends AbstractExportTool
implements WandoraTool

This index builder assumes the Solr database has fields:

  <field name="id" type="string" indexed="true" stored="true" required="true" multiValued="false" /> 
  <field name="basename" type="text_general" indexed="true" stored="true" />  
  <field name="sl" type="string" indexed="true" stored="true" multiValued="false" /> 
  <field name="si" type="string" indexed="true" stored="true" multiValued="true"/> 
  <field name="name" type="text_general" indexed="true" stored="true" multiValued="true"/> 
  <field name="occurrence" type="text_general" indexed="true" stored="true" multiValued="true"/> 
  

http://wiki.apache.org/solr/Solrj

Author:

akivela

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	deleteEverythingFirst
boolean	EXPORT_SELECTION_INSTEAD_TOPIC_MAP
protected static boolean	indexOccurrences
protected java.lang.String	serverUrl

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Constructor Summary

Constructors

Constructor and Description
SolrIndexBuilder()
SolrIndexBuilder(boolean exportSelection)

Method Summary

Modifier and Type	Method and Description
void	configure(Wandora admin, Options options, java.lang.String prefix) If the tool is configurable, shows an user interface to configure the tool.
void	execute(Wandora admin, Context context) Runs the tool.
java.lang.String	getDescription() AdminToolManager views tool descriptions while user browses available tools and build user customizable GUI elements such as Tools menu.
javax.swing.Icon	getIcon() All tools may have identifying graphic icon used within tool GUI elements.
java.lang.String	getName() Tools name represent the tool in UI unless the tool has been given explicitly another GUI name.
protected java.lang.String	getSolrIdFor(Topic t)
boolean	isConfigurable() Whether this tool is configurable.
protected void	makeSolrIndexFor(TopicMap tm, org.apache.solr.client.solrj.impl.HttpSolrServer solr)
protected org.apache.solr.common.SolrInputDocument	makeSolrInputDocumentFor(Topic t)
boolean	requiresRefresh() If any visible topic has been changed during tool execution GUI is automatically refreshed.

Methods inherited from class org.wandora.application.tools.exporters.AbstractExportTool

getType, makeTopicMapWith, makeTopicMapWith

Methods inherited from class org.wandora.application.tools.AbstractWandoraTool

addUndoMarker, addUndoMarker, allowMultipleInvocations, clearAllThreads, clearThreads, clearThreads, clearToolLock, clearToolLock, clearToolLocks, execute, execute, forceStop, forceStop, getContext, getCurrentLogger, getDefaultLogger, getHistory, getLastLogger, getState, getThreads, getThreads, getToolMenuItem, getToolMenuItem, getTopicName, hlog, initialize, interruptAllThreads, interruptThreads, interruptThreads, isRunning, isRunning, lockLog, log, log, log, log, run, runInOwnThread, setContext, setDefaultLogger, setLogTitle, setProgress, setProgressMax, setState, setToolLogger, singleLog, singleLog, singleLog, solveContextTopicMap, solveNameForTopicMap, writeOptions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.wandora.application.WandoraTool

execute, execute, getContext, getToolMenuItem, getType, hlog, initialize, isRunning, log, log, log, log, setContext, setToolLogger, writeOptions

Methods inherited from interface org.wandora.application.WandoraToolLogger

forceStop, getHistory, getState, lockLog, setLogTitle, setProgress, setProgressMax, setState

Field Detail

EXPORT_SELECTION_INSTEAD_TOPIC_MAP

public boolean EXPORT_SELECTION_INSTEAD_TOPIC_MAP

indexOccurrences

protected static boolean indexOccurrences

deleteEverythingFirst

protected boolean deleteEverythingFirst

serverUrl

protected java.lang.String serverUrl

Constructor Detail

SolrIndexBuilder

public SolrIndexBuilder()

SolrIndexBuilder

public SolrIndexBuilder(boolean exportSelection)

Method Detail

getIcon

public javax.swing.Icon getIcon()

Description copied from class: AbstractWandoraTool

All tools may have identifying graphic icon used within tool GUI elements. getIcon should return Icon object of the tool.

Specified by:

getIcon in interface WandoraTool

Overrides:

getIcon in class AbstractExportTool

Returns:

icon for the tool.

requiresRefresh

public boolean requiresRefresh()

Description copied from class: AbstractWandoraTool

If any visible topic has been changed during tool execution GUI is automatically refreshed. If tool doesn't change topics but GUI still requires refresh, tool should override this method and return true.

For example tools that alter the GUI but change no topics should return true.

Specified by:

requiresRefresh in interface WandoraTool

Overrides:

requiresRefresh in class AbstractWandoraTool

Returns:

true if Wandora application should refresh user interface.

isConfigurable

public boolean isConfigurable()

Description copied from class: AbstractWandoraTool

Whether this tool is configurable. Configurable tools will provide an interface to configure themselves. To make a configurable tool you will need to:

• Implement isConfigurable method and return true there.
• Implement initialize method to initialize the tool with saved options.
• Implement configure method to provide the user interface for configuration and then save the new options.
• Implement writeOptions method to save the current options.

Specified by:

isConfigurable in interface WandoraTool

Overrides:

isConfigurable in class AbstractWandoraTool

Returns:

true if the tool is configurable.

configure

public void configure(Wandora admin,
                      Options options,
                      java.lang.String prefix)
               throws TopicMapException

Description copied from class: AbstractWandoraTool

If the tool is configurable, shows an user interface to configure the tool. The user may edit tool options which this method also need to save. Options specific to this tool should be saved with keys starting with the given prefix.

Specified by:

configure in interface WandoraTool

Overrides:

configure in class AbstractWandoraTool

Throws:

TopicMapException

execute

public void execute(Wandora admin,
                    Context context)

Description copied from interface: WandoraTool

Runs the tool. This is the main entry to the tool. Here the context

Specified by:

execute in interface WandoraTool

getName

public java.lang.String getName()

Description copied from class: AbstractWandoraTool

Tools name represent the tool in UI unless the tool has been given explicitly another GUI name. All tools should override this method and return a valid string representing name of the tool.

Specified by:

getName in interface WandoraTool

Overrides:

getName in class AbstractWandoraTool

Returns:

String representing tool's name.

getDescription

public java.lang.String getDescription()

Description copied from class: AbstractWandoraTool

AdminToolManager views tool descriptions while user browses available tools and build user customizable GUI elements such as Tools menu. By default description equals the tool name. All tools should override this method.

Specified by:

getDescription in interface WandoraTool

Overrides:

getDescription in class AbstractWandoraTool

Returns:

String representing tool's description.

makeSolrIndexFor

protected void makeSolrIndexFor(TopicMap tm,
                                org.apache.solr.client.solrj.impl.HttpSolrServer solr)
                         throws TopicMapException,
                                org.apache.solr.client.solrj.SolrServerException,
                                java.io.IOException

Throws:

TopicMapException

org.apache.solr.client.solrj.SolrServerException

java.io.IOException

makeSolrInputDocumentFor

protected org.apache.solr.common.SolrInputDocument makeSolrInputDocumentFor(Topic t)
                                                                     throws TopicMapException

Throws:

TopicMapException

getSolrIdFor

protected java.lang.String getSolrIdFor(Topic t)