|
Qizx fe-4.4p2 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.qizx.api.Configuration
public class Configuration
Bootstrap Configuration for Qizx.
Replaces the deprecated LibraryManagerFactory
.
Methods of this class allow:
openLibraryGroup(File)
and createLibraryGroup(File)
.
createSessionManager(java.lang.String)
Nested Class Summary | |
---|---|
static class |
Configuration.Property
Properties of Qizx Configuration. |
Field Summary | |
---|---|
static Configuration.Property |
ALLOWED_CLASSES
List of classes allowed for Java function Binding. |
static Configuration.Property |
CONTENT_IMPORTERS
List of extension classes for import of semistructured content into an XML Library. |
static Configuration.Property |
DOC_BLOCK_SIZE
Size of blocks used for XML document storage. |
static Configuration.Property |
DOC_COMPRESS
Compression for XML document storage. |
static Configuration.Property |
DOC_INDEX_COMPRESS
Compression for XML dmocument indexes. |
static Configuration.Property |
DOC_NODE_STATS
Addition of Data-Model statistics as meta-properties of Documents |
static Configuration.Property |
DOC_SEGMENT_MAX_COUNT
Number of index segments of similar size that triggers a segment compaction (unless this would create a segment larger than specified property DOC_SEGMENT_MAX_SIZE). |
static Configuration.Property |
DOC_SEGMENT_MAX_SIZE
Maximum size in bytes for document index segments. |
static Configuration.Property |
FULLTEXT_FACTORY
Class used as a default FullTextFactory . |
static Configuration.Property |
LARGE_TX_DUPLICATE_CHECK
Checking of duplicate document paths inside large transactions (uses more memory). |
static Configuration.Property |
LOGGING_LEVEL
Logging level applied to all XML Libraries. |
static Configuration.Property |
LONG_COMPACTION_SIZE
Size threshold in index compaction for using a separate thread. |
static Configuration.Property |
MEMORY_LIMIT
Maximum memory size used by a LibraryManager (in bytes). |
static Configuration.Property |
META_BLOCK_SIZE
Size of blocks used for meta-properties storage. |
static Configuration.Property |
META_COMPRESS
Compression for metadata properties. |
static Configuration.Property |
META_INDEX_COMPRESS
Compression for metadata indexes. |
static Configuration.Property |
META_SEGMENT_MAX_COUNT
Number of index segments of similar size that triggers a segment compaction (unless this would create a segment larger than specified property META_SEGMENT_MAX_SIZE). |
static Configuration.Property |
META_SEGMENT_MAX_SIZE
Maximum size in bytes for metadata index segments (segment compaction will not create larger segments than this size) |
static Configuration.Property[] |
properties
|
static Configuration.Property |
READONLY_MODE
Read-only mode for new sessions. |
static Configuration.Property |
SHUTDOWN_COMPACTER_DELAY
Cut-off time on shutdown (closeAllLibraries) granted to cleanup and index optimization tasks. |
static Configuration.Property |
SYNC_COMMIT
Control of file-system sync on each commit for data safety. |
static Configuration.Property |
TRANSIENT_DOCUMENT_CACHE_SIZE
Size in bytes of the cache of parsed (or transient) XML documents. |
static Configuration.Property |
XQUERY_DEFAULT_COLLATION
|
static Configuration.Property |
XQUERY_IMPLICIT_TIMEZONE
|
static Configuration.Property |
XQUERY_STRICT_COMPLIANCE
|
static Configuration.Property |
XQUERY_STRICT_TYPING
|
Method Summary | |
---|---|
static void |
addContentImporter(String className)
Defines a ContentImporter by its class name. |
static LibraryManager |
createLibraryGroup(File groupDirectory)
Creates a group of XML Libraries and the LibraryManager controlling it. |
static LibraryManager |
createLibraryManager()
Creates a LibraryManager without group directory and without XML Libraries. |
static XQuerySessionManager |
createSessionManager(String baseURI)
Creates a plain Session Manager. |
static void |
defineExtensionDirectory(File directory)
Defines a directory containing extension jars. |
static void |
defineExtensionJar(File jarFile)
Defines an extension jars for add-ons. |
static String |
getAllowedClasses()
Returns a list of classes allowed for Java Binding. |
static Class<?> |
getExtensionClass(String className)
(Internal) finds a class name using extended classpath. |
static Object |
instantiate(String className)
(Internal) instantiates a class name using extended classpath. |
static Object |
instantiate(String className,
Class<?> implemented)
(Internal) instantiates a class name using extended classpath. |
static ContentImporter |
instantiateImporter(String formatName)
(Internal) instantiates a ContentImporter by its symbolic name. |
static File |
locateLibrary(File location)
Tests whether a directory contains an XML Library. |
static LibraryManager |
openLibraryGroup(File groupDirectory)
Starts a LibraryManager controlling an existing group of XML Libraries. |
static void |
set(Configuration.Property property,
Object value)
Sets a property, which will be inherited by LibraryManagers created by createLibraryGroup(File) , openLibraryGroup(File) or
createLibraryManager() . |
static void |
setLogHandler(Handler handler)
Defines a bootstrap Log Handler used when creating LibraryManagers or plain sessions. |
static void |
setup(Properties properties)
Defines a set of properties which will be inherited by LibraryManagers created by createLibraryGroup(File) ,
openLibraryGroup(File) or createLibraryManager() . |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final Configuration.Property LOGGING_LEVEL
public static final Configuration.Property MEMORY_LIMIT
LibraryManager
is similar to use setMemoryLimit().
public static final Configuration.Property READONLY_MODE
public static final Configuration.Property SYNC_COMMIT
public static final Configuration.Property SHUTDOWN_COMPACTER_DELAY
public static final Configuration.Property TRANSIENT_DOCUMENT_CACHE_SIZE
LibraryManager
or XQuerySessionManager
public static final Configuration.Property FULLTEXT_FACTORY
FullTextFactory
.
public static final Configuration.Property CONTENT_IMPORTERS
The value is a comma-separated list of class names, each class must
implement ContentImporter
.
Example: "com.qizx.xmodule.importer.json.JsonImporter
public static final Configuration.Property ALLOWED_CLASSES
The value is a comma-separated list of class names.
Example: "org.expath.zip.qizx.Functions"
public static final Configuration.Property DOC_NODE_STATS
public static final Configuration.Property DOC_COMPRESS
Value is boolean, default value is true.
public static final Configuration.Property DOC_INDEX_COMPRESS
Value is boolean, default value is true.
public static final Configuration.Property DOC_SEGMENT_MAX_SIZE
Value is Long, default value is 6 Gigabytes.
public static final Configuration.Property DOC_SEGMENT_MAX_COUNT
Value is integer, default value is 8.
public static final Configuration.Property DOC_BLOCK_SIZE
public static final Configuration.Property META_COMPRESS
Value is boolean, default value is true.
public static final Configuration.Property META_INDEX_COMPRESS
Value is boolean, default value is true.
public static final Configuration.Property META_SEGMENT_MAX_SIZE
Value is Long, default value is 0.5 Gigabytes.
public static final Configuration.Property META_SEGMENT_MAX_COUNT
public static final Configuration.Property META_BLOCK_SIZE
public static final Configuration.Property LARGE_TX_DUPLICATE_CHECK
Value is boolean, default value is true.
public static final Configuration.Property LONG_COMPACTION_SIZE
public static final Configuration.Property XQUERY_IMPLICIT_TIMEZONE
public static final Configuration.Property XQUERY_DEFAULT_COLLATION
public static final Configuration.Property XQUERY_STRICT_TYPING
public static final Configuration.Property XQUERY_STRICT_COMPLIANCE
public static Configuration.Property[] properties
Method Detail |
---|
public static void setup(Properties properties) throws IllegalArgumentException
createLibraryGroup(File)
,
openLibraryGroup(File)
or createLibraryManager()
.
properties
-
IllegalArgumentException
public static void set(Configuration.Property property, Object value) throws IllegalArgumentException
createLibraryGroup(File)
, openLibraryGroup(File)
or
createLibraryManager()
.
property
- see Configuration.Property
value
- see each Configuration.Property
IllegalArgumentException
public static String getAllowedClasses()
These classes are defined by set(ALLOWED_CLASSES
, names).
Notice that this property value is cumulative: repeated calls add new names
to the current list. To erase the lsit, set a value of null
.
public static void setLogHandler(Handler handler)
handler
- public static void defineExtensionJar(File jarFile)
jarFile
- a jar file.public static void defineExtensionDirectory(File directory)
directory
- a readable directorypublic static Class<?> getExtensionClass(String className) throws ClassNotFoundException
className
- full name of a class
ClassNotFoundException
public static Object instantiate(String className) throws InstantiationException
className
- full name of a class
InstantiationException
public static Object instantiate(String className, Class<?> implemented) throws InstantiationException
className
- full name of a classimplemented
- a superclass or interface
InstantiationException
public static XQuerySessionManager createSessionManager(String baseURI) throws QizxException
new XQuerySessionManager()
.
Sets a default Module Resolver with a base URI and a default cache for parsed documents.
baseURI
- a base URI for resolution of modules.
QizxException
- if storageDir exists and is not empty.public static File locateLibrary(File location) throws FileNotFoundException
location
- a directory supposedly containing an
XML Library. It can also be any file or directory within an XML Library.
FileNotFoundException
- if parent directory cannot be accessedpublic static LibraryManager createLibraryManager() throws QizxException
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)
.
QizxException
- if storageDir exists and is not empty.public static LibraryManager createLibraryGroup(File groupDirectory) throws QizxException
There is initially no XML Library in the created group. A Library can be
added by LibraryManager.createLibrary(java.lang.String, java.io.File)
.
groupDirectory
- a directory which is the location of the Library
Group. This directory is created if it does not exist.
QizxException
- if storageDir exists and is not empty.public static LibraryManager openLibraryGroup(File groupDirectory) throws QizxException
XML Libraries are located as sub-directories of the 'group directory'. They are found by scanning the group directory (the descriptor file group.qlg is deprecated).
groupDirectory
- a directory which is the root location of the group.
QizxException
- if storageDir has not been initialized by
invoking createLibraryGroup(File)
.public static void addContentImporter(String className) throws InstantiationException
className
- full class name.
InstantiationException
public static ContentImporter instantiateImporter(String formatName) throws InstantiationException
formatName
- symbolic name, e.g "json".
InstantiationException
|
© 2010 Axyana Software | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |