Qizx fe-4.4p2 API

com.qizx.api
Class LibraryManagerFactory

java.lang.Object
  extended by com.qizx.api.LibraryManagerFactory

Deprecated. since 4.2

public abstract class LibraryManagerFactory
extends Object

Factory used to initialize a LibraryManager. A LibraryManager instance is obtained:


Method Summary
abstract  LibraryManager createLibraryGroup(File groupDirectory)
          Deprecated. Creates a LibraryManager controlling a group of XML Libraries
abstract  LibraryManager createManager()
          Deprecated. Creates a LibraryManager without group directory and without XML Libraries.
static LibraryManagerFactory getInstance()
          Deprecated. Creates an instance of the factory, which can be used to configure a LibraryManager.
abstract  long getMemoryLimit()
          Deprecated. from 4.0, use LibraryManager.getMemoryLimit().
static File locateLibrary(File location)
          Deprecated. Tests whether a directory contains an XML Library.
abstract  LibraryManager openLibraryGroup(File groupDirectory)
          Deprecated. Starts a LibraryManager controlling an existing group of XML Libraries located as sub-directories of the 'group directory'.
abstract  void setLogHandler(Handler handler)
          Deprecated. Defines a supplementary Log Handler used on new LibraryManagers.
abstract  void setMemoryLimit(long size)
          Deprecated. from 4.0, use LibraryManager.setMemoryLimit(long).
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getInstance

public static LibraryManagerFactory getInstance()
Deprecated. 
Creates an instance of the factory, which can be used to configure a LibraryManager.

Returns:
a unique instance of this factory

locateLibrary

public static File locateLibrary(File location)
                          throws FileNotFoundException
Deprecated. 
Tests whether a directory contains an XML Library.

Parameters:
location - a directory supposedly containing an XML Library. It can also be any file or directory within an XML Library.
Returns:
the directory containing the Qizx XML Library, or null if the location does not correspond to an XML Library.
Throws:
FileNotFoundException - if parent directory cannot be accessed
Since:
4.0

createManager

public abstract LibraryManager createManager()
                                      throws QizxException
Deprecated. 
Creates a LibraryManager without group directory and without XML Libraries.

Libraries can then be managed through LibraryManager.manageLibrary(java.lang.String, java.io.File) or created through LibraryManager.createLibrary(java.lang.String, java.io.File).

Returns:
an active LibraryManager managing the new group.
Throws:
QizxException - if storageDir exists and is not empty.

createLibraryGroup

public abstract LibraryManager createLibraryGroup(File groupDirectory)
                                           throws QizxException
Deprecated. 
Creates a LibraryManager controlling a group of XML Libraries

There is initially no XML Library in the created group. A Library can be added by LibraryManager.createLibrary(java.lang.String, java.io.File).

Parameters:
groupDirectory - a directory which is the location of the Library Group. This directory is created if it does not exist.
Returns:
an active LibraryManager managing the new group.
Throws:
QizxException - if storageDir exists and is not empty.

openLibraryGroup

public abstract LibraryManager openLibraryGroup(File groupDirectory)
                                         throws QizxException
Deprecated. 
Starts a LibraryManager controlling an existing group of XML Libraries located as sub-directories of the 'group directory'. These XML Libraries are found and opened by scanning the group directory (the descriptor file group.qlg is deprecated).

Parameters:
groupDirectory - a directory which is the root location of the group.
Returns:
an active LibraryManager managing the group.
Throws:
QizxException - if storageDir has not been initialized by invoking createLibraryGroup(File).

setLogHandler

public abstract void setLogHandler(Handler handler)
Deprecated. 
Defines a supplementary Log Handler used on new LibraryManagers.

Parameters:
handler -

setMemoryLimit

public abstract void setMemoryLimit(long size)
Deprecated. from 4.0, use LibraryManager.setMemoryLimit(long).

Defines the maximum memory size the generated LibraryManager can use.

Parameters:
size - maximum size in bytes of memory allocated to the LibraryManager.
See Also:
getMemoryLimit()

getMemoryLimit

public abstract long getMemoryLimit()
Deprecated. from 4.0, use LibraryManager.getMemoryLimit().

Defines the maximum memory size the generated LibraryManager can use.

Returns:
maximum size in bytes of memory allocated to the LibraryManager.
See Also:
setMemoryLimit(long)

© 2010 Axyana Software