org.wandora.piccolo

Class WandoraManager

java.lang.Object

org.wandora.piccolo.WandoraManager

All Implemented Interfaces:

java.lang.Runnable, TopicMapListener

Direct Known Subclasses:

WandoraService

public class WandoraManager
extends java.lang.Object
implements java.lang.Runnable, TopicMapListener

Author:

olli

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	WandoraManager.WandoraShutdownHook

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	adminPass
static java.lang.String	ASSOCIATIONROLE_SI
static java.lang.String	ASSOCIATIONROLECATEGORIES_SI
static java.lang.String	ASSOCIATIONTYPE_SI
private java.lang.String	autoSaveFile
private java.util.ArrayList	autoSaveMaps
private static long	baseLocatorCounter
static java.lang.String	CATEGORYHIERARCHY_SI
private java.util.HashSet	changedTopics
private java.util.HashSet	changedTopicsShallow
static java.lang.String	ENTRYTIME_SI
static java.lang.String	HIDELEVEL_SI
private java.lang.String	historySaveFile
private boolean	indexNeedsUpdate
private boolean	keepHistory
static java.lang.String	LANGINDEPENDENT_SI
static java.lang.String	LANGUAGE_SI
private boolean	lazyIndexUpdate
static int	LOCK_READ
static int	LOCK_WRITE
private Logger	logger
static java.lang.String	OCCURRENCETYPE_SI
private java.lang.String	projectFile
private boolean	projectFileAutoUpdate
private long	projectFileDateStamp
static java.lang.String	PROP_ADMINPASS
static java.lang.String	PROP_AUTOSAVEFILE
static java.lang.String	PROP_AUTOSAVEHISTORYFILE
static java.lang.String	PROP_AUTOSAVEINTERVAL
static java.lang.String	PROP_AUTOSAVEMAPS
static java.lang.String	PROP_FACTORYFEATURES
static java.lang.String	PROP_FACTORYPROPERTIES
static java.lang.String	PROP_INDEXPATH
static java.lang.String	PROP_KEEPHISTORY
static java.lang.String	PROP_LAZYINDEXUPDATE
static java.lang.String	PROP_PROJECTFILE
static java.lang.String	PROP_PROJECTFILE_AUTOUPDATE
static java.lang.String	PROP_SHUTDOWNHOOK
static java.lang.String	ROLE_SI
private int	runCount
private boolean	running
private long	saveInterval
private org.apache.lucene.search.IndexSearcher	searcher
private java.lang.String	searchIndexPath
private ReaderWriterLock	searchLock
static java.lang.String	SUBCATEGORY_SI
static java.lang.String	SUPERCATEGORY_SI
private TMBox	tmBox
private ReaderWriterLock	tmLock
private TopicMap	topicMap
private java.util.HashMap	topicMaps
static java.lang.String	VARIANT_NAME_VERSION_SI
static java.lang.String	WANDORACLASS_SI
private java.lang.Thread	workerThread

Constructor Summary

Constructors

Constructor and Description
WandoraManager()
WandoraManager(Logger logger)
WandoraManager(Logger logger, java.util.Properties properties, java.lang.String prefix)
WandoraManager(java.util.Properties properties)
WandoraManager(java.util.Properties properties, java.lang.String prefix)

Method Summary

Modifier and Type	Method and Description
void	addTopicMap(java.lang.String key, TopicMap tm)
void	associationChanged(Association a) A notification used to report general or large changes in association.
void	associationPlayerChanged(Association a, Topic role, Topic newPlayer, Topic oldPlayer) A notification that a player in an association with a certain role has been changed.
void	associationRemoved(Association a) A notification that an association has been completely removed.
void	associationTypeChanged(Association a, Topic newType, Topic oldType) A notification that association type has changed.
private void	buildIndex(java.lang.String indexPath, TopicMap tm)
private void	closeSearcher()
Locator	createLocator(java.lang.String uri)
TopicMap	createTopicMap()
void	doShutdown()
static java.lang.String	getFreeBaseLocator()
TMBox	getTMBox()
Topic	getTopicByName(java.lang.String name)
Topic	getTopicBySI(Locator si)
Topic	getTopicBySI(java.lang.String si)
TopicMap	getTopicMap()
TopicMap	getTopicMap(java.lang.String key)
java.util.Collection	getTopicsOfType(Locator l)
java.util.Collection	getTopicsOfType(java.lang.String si)
boolean	indexNeedsUpdate()
void	initialize(TopicMap tm)
boolean	isAdminUser(java.lang.String user, java.lang.String password)
boolean	isLazyIndexUpdate()
java.lang.Object	lockObject(int depth, Topic object, int mode)
java.lang.Object	lockObject(LockCallBack callback, java.util.Set start, int mode)
boolean	lockTopicMap(int mode)
static void	main(java.lang.String[] args)
void	mergeInTopicMap(java.io.InputStream in)
void	mergeInTopicMap(TopicMap tm)
void	mergeInTopicMapNoLock(java.io.InputStream in)
void	mergeInTopicMapNoLock(TopicMap tm)
void	mergeInTopicMaps(java.util.Collection urls)
void	mergeInTopicMapsNoLock(java.util.Collection urls)
TopicMap	readTopicMap(java.io.InputStream in)
TopicMap	readTopicMap(java.io.InputStream in, java.lang.String key)
TopicMap	readTopicMap(java.lang.String file)
TopicMap	readTopicMap(java.lang.String file, java.lang.String key)
void	rebuildSearchIndex()
void	rebuildSearchIndex(boolean checkNeedsUpdate)
void	releaseObject(java.lang.Object handle)
void	releaseTopicMap(int mode)
void	run()
void	saveTopicMaps(boolean locked)
void	saveTopicMapsNoLock()
java.util.Collection	search(java.lang.String query)
java.util.Collection	search(java.lang.String query, java.lang.String lang)
private java.util.Collection	searchTopic(java.lang.String word, int searchIndex)
private java.util.Collection	searchTopic(java.lang.String word, java.lang.String searchIndex)
private java.util.Collection	searchTopic(java.lang.String word, java.lang.String searchIndex, java.lang.String lang)
void	serializeTopicMap(TopicMap tm, java.io.OutputStream out)
void	topicBaseNameChanged(Topic t, java.lang.String newName, java.lang.String oldName) Notification that the base name has been changed.
void	topicChanged(Topic topic) A notification used to report general or large changes in topic, for example when topics are merged.
void	topicChanged(Topic topic, boolean shallow)
void	topicDataChanged(Topic t, Topic type, Topic version, java.lang.String newValue, java.lang.String oldValue) Notification that topic occurrence has been changed.
void	topicRemoved(Topic t) Notification that a topic has been completely removed.
void	topicSubjectIdentifierChanged(Topic t, Locator added, Locator removed) Notification that a subject identifier has changed.
void	topicSubjectLocatorChanged(Topic t, Locator newLocator, Locator oldLocator) Notification that the subject locator has been changed.
void	topicTypeChanged(Topic t, Topic added, Topic removed) Notification that a topic type has changed.
void	topicVariantChanged(Topic t, java.util.Collection<Topic> scope, java.lang.String newName, java.lang.String oldName) Notification that a variant name has been changed.
private void	updateIndex(java.util.Set changed, java.util.Set changedShallow, java.lang.String indexPath, TopicMap tm)
void	updateSearchIndex()

Methods inherited from class java.lang.Object

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

Field Detail

WANDORACLASS_SI

public static final java.lang.String WANDORACLASS_SI

See Also:

Constant Field Values

ASSOCIATIONTYPE_SI

public static final java.lang.String ASSOCIATIONTYPE_SI

See Also:

Constant Field Values

ASSOCIATIONROLE_SI

public static final java.lang.String ASSOCIATIONROLE_SI

See Also:

Constant Field Values

ROLE_SI

public static final java.lang.String ROLE_SI

See Also:

Constant Field Values

LANGINDEPENDENT_SI

public static final java.lang.String LANGINDEPENDENT_SI

See Also:

Constant Field Values

ASSOCIATIONROLECATEGORIES_SI

public static final java.lang.String ASSOCIATIONROLECATEGORIES_SI

See Also:

Constant Field Values

OCCURRENCETYPE_SI

public static final java.lang.String OCCURRENCETYPE_SI

See Also:

Constant Field Values

HIDELEVEL_SI

public static final java.lang.String HIDELEVEL_SI

See Also:

Constant Field Values

CATEGORYHIERARCHY_SI

public static final java.lang.String CATEGORYHIERARCHY_SI

See Also:

Constant Field Values

SUPERCATEGORY_SI

public static final java.lang.String SUPERCATEGORY_SI

See Also:

Constant Field Values

SUBCATEGORY_SI

public static final java.lang.String SUBCATEGORY_SI

See Also:

Constant Field Values

ENTRYTIME_SI

public static final java.lang.String ENTRYTIME_SI

See Also:

Constant Field Values

VARIANT_NAME_VERSION_SI

public static final java.lang.String VARIANT_NAME_VERSION_SI

See Also:

Constant Field Values

LANGUAGE_SI

public static final java.lang.String LANGUAGE_SI

See Also:

Constant Field Values

LOCK_READ

public static final int LOCK_READ

See Also:

Constant Field Values

LOCK_WRITE

public static final int LOCK_WRITE

See Also:

Constant Field Values

PROP_LAZYINDEXUPDATE

public static final java.lang.String PROP_LAZYINDEXUPDATE

See Also:

Constant Field Values

PROP_INDEXPATH

public static final java.lang.String PROP_INDEXPATH

See Also:

Constant Field Values

PROP_AUTOSAVEFILE

public static final java.lang.String PROP_AUTOSAVEFILE

See Also:

Constant Field Values

PROP_AUTOSAVEHISTORYFILE

public static final java.lang.String PROP_AUTOSAVEHISTORYFILE

See Also:

Constant Field Values

PROP_AUTOSAVEINTERVAL

public static final java.lang.String PROP_AUTOSAVEINTERVAL

See Also:

Constant Field Values

PROP_KEEPHISTORY

public static final java.lang.String PROP_KEEPHISTORY

See Also:

Constant Field Values

PROP_FACTORYFEATURES

public static final java.lang.String PROP_FACTORYFEATURES

See Also:

Constant Field Values

PROP_FACTORYPROPERTIES

public static final java.lang.String PROP_FACTORYPROPERTIES

See Also:

Constant Field Values

PROP_SHUTDOWNHOOK

public static final java.lang.String PROP_SHUTDOWNHOOK

See Also:

Constant Field Values

PROP_AUTOSAVEMAPS

public static final java.lang.String PROP_AUTOSAVEMAPS

See Also:

Constant Field Values

PROP_ADMINPASS

public static final java.lang.String PROP_ADMINPASS

See Also:

Constant Field Values

PROP_PROJECTFILE

public static final java.lang.String PROP_PROJECTFILE

See Also:

Constant Field Values

PROP_PROJECTFILE_AUTOUPDATE

public static final java.lang.String PROP_PROJECTFILE_AUTOUPDATE

See Also:

Constant Field Values

tmLock

private ReaderWriterLock tmLock

searchLock

private ReaderWriterLock searchLock

searcher

private org.apache.lucene.search.IndexSearcher searcher

topicMap

private TopicMap topicMap

topicMaps

private java.util.HashMap topicMaps

changedTopics

private java.util.HashSet changedTopics

changedTopicsShallow

private java.util.HashSet changedTopicsShallow

tmBox

private TMBox tmBox

searchIndexPath

private java.lang.String searchIndexPath

projectFile

private java.lang.String projectFile

projectFileDateStamp

private long projectFileDateStamp

projectFileAutoUpdate

private boolean projectFileAutoUpdate

workerThread

private java.lang.Thread workerThread

running

private boolean running

runCount

private int runCount

saveInterval

private long saveInterval

keepHistory

private boolean keepHistory

lazyIndexUpdate

private boolean lazyIndexUpdate

indexNeedsUpdate

private boolean indexNeedsUpdate

autoSaveFile

private java.lang.String autoSaveFile

historySaveFile

private java.lang.String historySaveFile

autoSaveMaps

private java.util.ArrayList autoSaveMaps

logger

private Logger logger

adminPass

private static java.lang.String adminPass

baseLocatorCounter

private static long baseLocatorCounter

Constructor Detail

WandoraManager

public WandoraManager()

WandoraManager

public WandoraManager(Logger logger)

WandoraManager

public WandoraManager(java.util.Properties properties)

WandoraManager

public WandoraManager(java.util.Properties properties,
                      java.lang.String prefix)

WandoraManager

public WandoraManager(Logger logger,
                      java.util.Properties properties,
                      java.lang.String prefix)

Method Detail

initialize

public void initialize(TopicMap tm)
                throws TopicMapException

Throws:

TopicMapException

addTopicMap

public void addTopicMap(java.lang.String key,
                        TopicMap tm)

getTopicMap

public TopicMap getTopicMap(java.lang.String key)

getFreeBaseLocator

public static java.lang.String getFreeBaseLocator()

createTopicMap

public TopicMap createTopicMap()

readTopicMap

public TopicMap readTopicMap(java.lang.String file)
                      throws java.io.IOException,
                             TopicMapException

Throws:

java.io.IOException

TopicMapException

readTopicMap

public TopicMap readTopicMap(java.lang.String file,
                             java.lang.String key)
                      throws java.io.IOException,
                             TopicMapException

Throws:

java.io.IOException

TopicMapException

readTopicMap

public TopicMap readTopicMap(java.io.InputStream in)
                      throws java.io.IOException,
                             TopicMapException

Throws:

java.io.IOException

TopicMapException

readTopicMap

public TopicMap readTopicMap(java.io.InputStream in,
                             java.lang.String key)
                      throws java.io.IOException,
                             TopicMapException

Throws:

java.io.IOException

TopicMapException

serializeTopicMap

public void serializeTopicMap(TopicMap tm,
                              java.io.OutputStream out)
                       throws java.io.IOException,
                              WandoraException

Throws:

java.io.IOException

WandoraException

mergeInTopicMapsNoLock

public void mergeInTopicMapsNoLock(java.util.Collection urls)
                            throws WandoraException

Throws:

WandoraException

mergeInTopicMaps

public void mergeInTopicMaps(java.util.Collection urls)
                      throws WandoraException

Throws:

WandoraException

mergeInTopicMap

public void mergeInTopicMap(java.io.InputStream in)
                     throws java.io.IOException,
                            WandoraException

Throws:

java.io.IOException

WandoraException

mergeInTopicMapNoLock

public void mergeInTopicMapNoLock(java.io.InputStream in)
                           throws java.io.IOException,
                                  WandoraException

Throws:

java.io.IOException

WandoraException

mergeInTopicMap

public void mergeInTopicMap(TopicMap tm)
                     throws WandoraException

Throws:

WandoraException

mergeInTopicMapNoLock

public void mergeInTopicMapNoLock(TopicMap tm)
                           throws WandoraException

Throws:

WandoraException

createLocator

public Locator createLocator(java.lang.String uri)

getTopicMap

public TopicMap getTopicMap()

lockObject

public java.lang.Object lockObject(int depth,
                                   Topic object,
                                   int mode)

lockTopicMap

public boolean lockTopicMap(int mode)

releaseTopicMap

public void releaseTopicMap(int mode)

lockObject

public java.lang.Object lockObject(LockCallBack callback,
                                   java.util.Set start,
                                   int mode)

releaseObject

public void releaseObject(java.lang.Object handle)

getTopicBySI

public Topic getTopicBySI(java.lang.String si)

getTopicBySI

public Topic getTopicBySI(Locator si)

getTopicsOfType

public java.util.Collection getTopicsOfType(java.lang.String si)

getTopicsOfType

public java.util.Collection getTopicsOfType(Locator l)

getTopicByName

public Topic getTopicByName(java.lang.String name)

indexNeedsUpdate

public boolean indexNeedsUpdate()

isLazyIndexUpdate

public boolean isLazyIndexUpdate()

search

public java.util.Collection search(java.lang.String query)
                            throws WandoraException

Throws:

WandoraException

search

public java.util.Collection search(java.lang.String query,
                                   java.lang.String lang)
                            throws WandoraException

Throws:

WandoraException

updateSearchIndex

public void updateSearchIndex()
                       throws WandoraException

Throws:

WandoraException

rebuildSearchIndex

public void rebuildSearchIndex()
                        throws WandoraException

Throws:

WandoraException

rebuildSearchIndex

public void rebuildSearchIndex(boolean checkNeedsUpdate)
                        throws WandoraException

Throws:

WandoraException

getTMBox

public TMBox getTMBox()

closeSearcher

private void closeSearcher()
                    throws java.io.IOException

Throws:

java.io.IOException

buildIndex

private void buildIndex(java.lang.String indexPath,
                        TopicMap tm)
                 throws java.io.IOException

Throws:

java.io.IOException

updateIndex

private void updateIndex(java.util.Set changed,
                         java.util.Set changedShallow,
                         java.lang.String indexPath,
                         TopicMap tm)
                  throws java.io.IOException,
                         TopicMapException

Parameters:

changed - The subject indicators of the changed topics as Strings. Only one subject indicator per changed topic is needed although it doesn't matter if it contains several subject indicators of the same topic.

Throws:

java.io.IOException

TopicMapException

searchTopic

private java.util.Collection searchTopic(java.lang.String word,
                                         int searchIndex)
                                  throws java.io.IOException

Throws:

java.io.IOException

searchTopic

private java.util.Collection searchTopic(java.lang.String word,
                                         java.lang.String searchIndex)
                                  throws java.io.IOException

Throws:

java.io.IOException

searchTopic

private java.util.Collection searchTopic(java.lang.String word,
                                         java.lang.String searchIndex,
                                         java.lang.String lang)
                                  throws java.io.IOException

Throws:

java.io.IOException

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Throws:

java.lang.Exception

saveTopicMaps

public void saveTopicMaps(boolean locked)
                   throws java.io.IOException,
                          TopicMapException

Throws:

java.io.IOException

TopicMapException

saveTopicMapsNoLock

public void saveTopicMapsNoLock()
                         throws java.io.IOException,
                                TopicMapException

Throws:

java.io.IOException

TopicMapException

run

public void run()

Specified by:

run in interface java.lang.Runnable

doShutdown

public void doShutdown()

topicChanged

public void topicChanged(Topic topic)
                  throws TopicMapException

Description copied from interface: TopicMapListener

A notification used to report general or large changes in topic, for example when topics are merged. Such a large change may consist of any number of smaller changes that are NOT reported individually with the other listener methods. This method is used when tracking individual changes is hard to implement.

Specified by:

topicChanged in interface TopicMapListener

Throws:

TopicMapException

topicChanged

public void topicChanged(Topic topic,
                         boolean shallow)
                  throws TopicMapException

Throws:

TopicMapException

associationChanged

public void associationChanged(Association a)
                        throws TopicMapException

Description copied from interface: TopicMapListener

A notification used to report general or large changes in association. Such a large change may consist of any number of smaller changes that are NOT reported individually with the other listener methods. This method is used when tracking individual changes is hard to implement.

Specified by:

associationChanged in interface TopicMapListener

Throws:

TopicMapException

associationRemoved

public void associationRemoved(Association a)
                        throws TopicMapException

Description copied from interface: TopicMapListener

A notification that an association has been completely removed.

Specified by:

associationRemoved in interface TopicMapListener

Throws:

TopicMapException

topicRemoved

public void topicRemoved(Topic t)
                  throws TopicMapException

Description copied from interface: TopicMapListener

Notification that a topic has been completely removed.

Specified by:

topicRemoved in interface TopicMapListener

Throws:

TopicMapException

topicSubjectIdentifierChanged

public void topicSubjectIdentifierChanged(Topic t,
                                          Locator added,
                                          Locator removed)
                                   throws TopicMapException

Description copied from interface: TopicMapListener

Notification that a subject identifier has changed. Either added or removed is non-null and indicates that a subject identifier has been added or removed, respectively. The non-null parameter contains the new subject identifier or the removed subject identifier.

Specified by:

topicSubjectIdentifierChanged in interface TopicMapListener

Throws:

TopicMapException

topicBaseNameChanged

public void topicBaseNameChanged(Topic t,
                                 java.lang.String newName,
                                 java.lang.String oldName)
                          throws TopicMapException

Description copied from interface: TopicMapListener

Notification that the base name has been changed. Either newName or oldName may be null indicating that base name was removed or old name was empty.

Specified by:

topicBaseNameChanged in interface TopicMapListener

Throws:

TopicMapException

topicTypeChanged

public void topicTypeChanged(Topic t,
                             Topic added,
                             Topic removed)
                      throws TopicMapException

Description copied from interface: TopicMapListener

Notification that a topic type has changed. Either added or removed is non-null and indicates that a type has been added or removed, respectively. The non-null parameter contains the new type or the removed type.

Specified by:

topicTypeChanged in interface TopicMapListener

Throws:

TopicMapException

topicVariantChanged

public void topicVariantChanged(Topic t,
                                java.util.Collection<Topic> scope,
                                java.lang.String newName,
                                java.lang.String oldName)
                         throws TopicMapException

Description copied from interface: TopicMapListener

Notification that a variant name has been changed. Either newName or oldName may be null indicating that the variant name was removed or old name was empty.

Specified by:

topicVariantChanged in interface TopicMapListener

Throws:

TopicMapException

topicDataChanged

public void topicDataChanged(Topic t,
                             Topic type,
                             Topic version,
                             java.lang.String newValue,
                             java.lang.String oldValue)
                      throws TopicMapException

Description copied from interface: TopicMapListener

Notification that topic occurrence has been changed. Either newValue or oldValue may be null indicating that the occurrence was removed or old value was empty.

Specified by:

topicDataChanged in interface TopicMapListener

Throws:

TopicMapException

topicSubjectLocatorChanged

public void topicSubjectLocatorChanged(Topic t,
                                       Locator newLocator,
                                       Locator oldLocator)
                                throws TopicMapException

Description copied from interface: TopicMapListener

Notification that the subject locator has been changed. Either newLocator or oldLocator may be null indicating that locator was removed or there was no old locator.

Specified by:

topicSubjectLocatorChanged in interface TopicMapListener

Throws:

TopicMapException

associationTypeChanged

public void associationTypeChanged(Association a,
                                   Topic newType,
                                   Topic oldType)
                            throws TopicMapException

Description copied from interface: TopicMapListener

A notification that association type has changed. Either newType or oldType can be null to indicate that old or new type was null. When type is changed from one topic to another, both will be non-null.

Specified by:

associationTypeChanged in interface TopicMapListener

Throws:

TopicMapException

associationPlayerChanged

public void associationPlayerChanged(Association a,
                                     Topic role,
                                     Topic newPlayer,
                                     Topic oldPlayer)
                              throws TopicMapException

Description copied from interface: TopicMapListener

A notification that a player in an association with a certain role has been changed. Either newPlayer or oldPlayer can be null to indicate that the no new player for the role was set or that there was no player with the role previously. Both can also be non-null to indicate that the player of the role changed.

Specified by:

associationPlayerChanged in interface TopicMapListener

Throws:

TopicMapException

isAdminUser

public boolean isAdminUser(java.lang.String user,
                           java.lang.String password)