Qizx fe-4.4p2 API
A B C D E F G H I J L M N O P Q R S T U V W X

S

sanityCheck(Log, boolean, boolean) - Method in interface com.qizx.api.LibraryManager
Performs a validity check of all managed Libraries.
sanityCheck(Log, int, boolean) - Method in interface com.qizx.api.LibraryManager
Performs a validity check of all managed Libraries.
saveConfiguration() - Method in interface com.qizx.api.LibraryManager
Saves the current configuration properties of the LibraryManager onto a file attached to the Library Group (named group.conf).
SAXToPushStream - Class in com.qizx.api.util
Adapter from SAX2 to XMLPushStream.
SAXToPushStream(XMLPushStream) - Constructor for class com.qizx.api.util.SAXToPushStream
Builds a SAX to XMLPushStream adapter.
scoreAll(float[]) - Method in interface com.qizx.api.fulltext.Scorer
Computes the score of a conjunction ('ftand' or 'all') of full-text selections.
scoreAll(float[]) - Method in class com.qizx.api.util.fulltext.DefaultScorer
 
scoreOr(float[], int) - Method in interface com.qizx.api.fulltext.Scorer
Computes the score of a disjunction ('ftor' or 'any') of full-text selections.
scoreOr(float[], int) - Method in class com.qizx.api.util.fulltext.DefaultScorer
 
Scorer - Interface in com.qizx.api.fulltext
Customizable part of the full-text scoring algorithm.
scoreWord(float, float) - Method in interface com.qizx.api.fulltext.Scorer
Computes the score of a single word.
scoreWord(float, float) - Method in class com.qizx.api.util.fulltext.DefaultScorer
 
SENTENCE - Static variable in interface com.qizx.api.fulltext.TextTokenizer
Code returned by nextToken when a sentence boundary is recognized.
SequenceType - Interface in com.qizx.api
Type of an Item sequence.
serializeToString(Node) - Method in class com.qizx.api.util.XMLSerializer
Serializes a node and its subtree as a string.
serverControl(String) - Method in class com.qizx.apps.restapi.RestAPIConnection
Wraps the "server" command.
set(Configuration.Property, Object) - Static method in class com.qizx.api.Configuration
Sets a property, which will be inherited by LibraryManagers created by Configuration.createLibraryGroup(File), Configuration.openLibraryGroup(File) or Configuration.createLibraryManager().
setAcceptingWildcards(boolean) - Method in interface com.qizx.api.fulltext.TextTokenizer
If set to true, wildcard characters are recognized.
setAcceptingWildcards(boolean) - Method in class com.qizx.api.util.fulltext.DefaultTextTokenizer
 
setAcl(String) - Method in class com.qizx.apps.restapi.RestAPIConnection
Adds ACL rules to the current XML Library Wraps the "setacl" command.
setAutoCommitting(boolean) - Method in interface com.qizx.api.Library
Sets the auto-commit flag: if set to true, a commit is performed after the execution of each updating Expression (expression using XQuery Update instructions).
setBaseURI(String) - Method in interface com.qizx.api.XQueryContext
Sets the base URI used to resolve relative URIs in expressions.
setBoundarySpacePolicy(int) - Method in interface com.qizx.api.XQueryContext
Sets the default boundary space policy for element constructors.
setConstructionMode(int) - Method in interface com.qizx.api.XQueryContext
Sets the construction mode defined in the static context.
setContentHandler(ContentHandler) - Method in class com.qizx.api.util.NodeXMLReader
 
setContentHandler(ContentHandler) - Method in class com.qizx.api.util.PushStreamToSAX
Sets the current SAX content handler.
setContext(QName[]) - Method in class com.qizx.api.Indexing.Rule
Defines an optional context of ancestors to be matched.
setCredentials(String, String) - Method in class com.qizx.apps.restapi.RestAPIConnection
 
setCurrentDate(Date) - Method in interface com.qizx.api.XQueryContext
Sets a specific date/time for use in query evaluation, instead of the normal value (the system time at start of evaluation).
setCurrentItem(Item) - Method in interface com.qizx.api.Expression
Sets the initial value of the current item, accessible by the expression '.'.
setDefaultCollation(String) - Method in interface com.qizx.api.XQueryContext
Sets the URI of the default collation defined in the static context.
setDefaultElementNamespace(String) - Method in interface com.qizx.api.XQueryContext
Sets the URI of the default element namespace.
setDefaultFunctionNamespace(String) - Method in interface com.qizx.api.XQueryContext
Sets the URI of the default function namespace.
setDefaultOrderEmptyGreatest(boolean) - Method in interface com.qizx.api.XQueryContext
Sets the default order for empty sequences in 'order by' clauses.
setDefaultSieve() - Method in class com.qizx.api.Indexing.Rule
Sets a default Sieve according to the indexing type.
setDigitMax(int) - Method in interface com.qizx.api.fulltext.TextTokenizer
Sets the maximum number of digits a word can contain.
setDigitMax(int) - Method in class com.qizx.api.util.fulltext.DefaultTextTokenizer
 
setDocumentCache(DocumentPool) - Method in class com.qizx.api.XQuerySessionManager
For internal use.
setDocumentLocator(Locator) - Method in class com.qizx.api.util.SAXToPushStream
 
setDone(double) - Method in class com.qizx.api.admin.BackgroundTask
 
setDTDHandler(DTDHandler) - Method in class com.qizx.api.util.NodeXMLReader
 
setEncoding(String) - Method in class com.qizx.api.util.XMLSerializer
Sets the option ENCODING.
setEndTime(long) - Method in class com.qizx.api.admin.BackgroundTask
 
setEntityResolver(EntityResolver) - Method in class com.qizx.api.util.NodeXMLReader
 
setErrorCode(QName) - Method in exception com.qizx.api.QizxException
Defines the XQuery error code.
setErrorCode(String) - Method in exception com.qizx.api.QizxException
Defines the XQuery error code.
setErrorHandler(ErrorHandler) - Method in class com.qizx.api.util.NodeXMLReader
 
setErrorHandler(ErrorHandler) - Method in class com.qizx.api.util.PushStreamToSAX
Sets the current SAX error handler.
setFeature(String, boolean) - Method in class com.qizx.api.util.NodeXMLReader
 
setFormat(String, Locale) - Method in class com.qizx.api.util.text.FormatDateSieve
Sets the format used.
setFormat(String, Locale) - Method in class com.qizx.api.util.text.FormatNumberSieve
Sets the format used.
setFullText(byte) - Method in class com.qizx.api.Indexing.Rule
Specifies whether full-text indexing is applied to the element matched by this rule and to its descendants.
setFulltextEnabled(boolean) - Method in class com.qizx.api.Indexing
Enables or disables full-text indexing globally.
setFullTextFactory(FullTextFactory) - Method in interface com.qizx.api.LibraryManager
Defines a default FullTextFactory for all the XML Libraries opened or created from this Library Manager.
setFullTextFactory(FullTextFactory) - Method in interface com.qizx.api.XQuerySession
Redefines the full-text factory associated with the session.
setFullTextFactory(FullTextFactory) - Method in class com.qizx.api.XQuerySessionManager
 
setGroupDirectory(File) - Method in interface com.qizx.api.LibraryManager
Sets the top-level directory of the Library Group.
setImplicitTimeZone(TimeZone) - Method in interface com.qizx.api.XQueryContext
Defines the implicit time-zone in the execution context.
setIndent(int) - Method in class com.qizx.api.util.XMLSerializer
Extension: defines the number of spaces used for one level of indentation.
setIndexing(Indexing) - Method in interface com.qizx.api.Library
Defines the indexing rules used in this Library.
setIndexing(File) - Method in class com.qizx.apps.restapi.RestAPIConnection
Wraps the "setindexing" command.
setIndexing(String) - Method in class com.qizx.apps.restapi.RestAPIConnection
Wraps the "setindexing" command.
setIndexingType(int) - Method in class com.qizx.api.Indexing.Rule
Sets the indexxes targeted by this rule.
setInput(String) - Method in interface com.qizx.api.ContentImporter
Takes the data input from a String.
setInput(InputStream) - Method in interface com.qizx.api.ContentImporter
Takes the data input from a byte stream.
setInput(Reader) - Method in interface com.qizx.api.ContentImporter
Takes the data input from a character stream.
setIntegerProperty(String, long) - Method in interface com.qizx.api.LibraryMember
Convenience method: defines a long integer property.
setLexicalHandler(LexicalHandler) - Method in class com.qizx.api.util.PushStreamToSAX
Sets the current SAX lexical output handler.
setLibraryName(String) - Method in class com.qizx.apps.restapi.RestAPIConnection
Sets the name of the current XML Library.
setLogHandler(Handler) - Static method in class com.qizx.api.Configuration
Defines a bootstrap Log Handler used when creating LibraryManagers or plain sessions.
setLogHandler(Handler) - Method in class com.qizx.api.LibraryManagerFactory
Deprecated. Defines a supplementary Log Handler used on new LibraryManagers.
setMaxSnippetSize(int) - Method in class com.qizx.api.util.fulltext.FullTextSnippetExtractor
Sets the maximum number of words in a snippet.
setMaxStringLength(int) - Method in class com.qizx.api.Indexing
Defines the maximum length of text chunks that can be indexed in value indexes (Attribute and Simple element content).
setMaxWordLength(int) - Method in class com.qizx.api.Indexing
Defines the maximum length of words that can be indexed in the Full-text index.
setMaxWorkSize(int) - Method in class com.qizx.api.util.fulltext.FullTextSnippetExtractor
Sets the maximum number of words examined to create a snippet.
setMemoryLimit(long) - Method in interface com.qizx.api.LibraryManager
Defines the maximum memory size the generated LibraryManager can use.
setMemoryLimit(long) - Method in class com.qizx.api.LibraryManagerFactory
Deprecated. from 4.0, use LibraryManager.setMemoryLimit(long).
setMessage(String) - Method in class com.qizx.api.admin.Profiling
 
setMessages(Message[]) - Method in exception com.qizx.api.CompilationException
For internal use.
setMinWordLength(int) - Method in class com.qizx.api.Indexing
Defines the minimum length of words that can be indexed in the Full-text index.
setModuleResolver(ModuleResolver) - Method in interface com.qizx.api.LibraryManager
Sets the resolver used for resolving a module into actual locations.
setModuleResolver(ModuleResolver) - Method in interface com.qizx.api.XQuerySession
Defines a private Module resolver for the session.
setModuleResolver(ModuleResolver) - Method in class com.qizx.api.XQuerySessionManager
Defines a resolver of XQuery modules.
setName(QName) - Method in class com.qizx.api.Indexing.Rule
Defines the name of the element/attribute concerned by the rule.
setNamespaceInheritMode(int) - Method in interface com.qizx.api.XQueryContext
Sets the default inherit part of the copy-namespaces mode.
setNamespacePreserveMode(int) - Method in interface com.qizx.api.XQueryContext
Sets the default preserve part of the copy-namespaces mode.
setNsPrefixes(boolean) - Method in class com.qizx.api.util.PushStreamToSAX
Sets the "NS prefixes" option: controls namespace prefix output.
setOmitXMLDeclaration(boolean) - Method in class com.qizx.api.util.XMLSerializer
Sets the option OMIT_XML_DECLARATION
setOption(String, String) - Method in class com.qizx.api.util.XMLSerializer
Sets an option.
setOrderingMode(int) - Method in interface com.qizx.api.XQueryContext
Sets the default ordering mode for returned sequences.
setOutput(XMLPushStream) - Method in class com.qizx.api.util.DOMToPushStream
Redefines the current output handler.
setOutput(OutputStream, String) - Method in class com.qizx.api.util.XMLSerializer
Defines or redefines the output.
setOutput(Writer) - Method in class com.qizx.api.util.XMLSerializer
Defines or redefines the output.
setOutput(OutputStream) - Method in class com.qizx.api.util.XMLSerializer
Defines or redefines the output.
setParameters(String[]) - Method in interface com.qizx.api.Indexing.Sieve
Defines optional parameters for the sieve.
setParameters(String[]) - Method in class com.qizx.api.util.text.FormatDateSieve
 
setParameters(String[]) - Method in class com.qizx.api.util.text.FormatNumberSieve
 
setParameters(String[]) - Method in class com.qizx.api.util.text.ISODateSieve
 
setParsingSpecialChars(boolean) - Method in interface com.qizx.api.fulltext.TextTokenizer
If set to true, special characters are recognized.
setParsingSpecialChars(boolean) - Method in class com.qizx.api.util.fulltext.DefaultTextTokenizer
 
setProgressObserver(LibraryProgressObserver) - Method in interface com.qizx.api.Library
Sets a listener used to monitor the progress of different operations on the Library.
setProperty(String, Object) - Method in interface com.qizx.api.LibraryMember
Changes the value of a property.
setProperty(String, Object) - Method in class com.qizx.api.util.NodeXMLReader
 
setSieve(Indexing.NumberSieve) - Method in class com.qizx.api.Indexing.Rule
Defines the Numeric or Date Sieve associated with the rule.
setSpaceLimit(int) - Method in interface com.qizx.api.Expression
Defines a maximum for memory space used by evaluation.
setStack(EvaluationStackTrace[]) - Method in exception com.qizx.api.EvaluationException
For internal use.
setStartTime(long) - Method in class com.qizx.api.admin.BackgroundTask
 
setStrictCompliance(boolean) - Method in interface com.qizx.api.XQueryContext
Sets the strict compliance flag with XQuery Specifications.
setStrictTyping(boolean) - Method in interface com.qizx.api.XQueryContext
Sets the Strict Typing flag.
setStripWhiteSpace(boolean) - Method in class com.qizx.api.util.ImportOptions
 
setTimeOut(int) - Method in interface com.qizx.api.Expression
Defines a maximum time for evaluation.
setTraceObserver(TraceObserver) - Method in interface com.qizx.api.Expression
Sets a listener to receive evaluation traces.
setTransientDocumentCacheSize(long) - Method in interface com.qizx.api.LibraryManager
Sets the maximum memory size for the document cache.
setTransientDocumentCacheSize(long) - Method in class com.qizx.api.XQuerySessionManager
Sets the maximum memory size for the document cache.
setup(Properties) - Static method in class com.qizx.api.Configuration
Defines a set of properties which will be inherited by LibraryManagers created by Configuration.createLibraryGroup(File), Configuration.openLibraryGroup(File) or Configuration.createLibraryManager().
setValue(XQValue) - Method in exception com.qizx.api.EvaluationException
 
setWordSieve(Indexing.WordSieve) - Method in class com.qizx.api.Indexing
Defines the word sieve used for full-text indexing.
setWordSieve(Indexing.WordSieve) - Method in interface com.qizx.api.XQuerySession
Deprecated. see XQuerySession.setFullTextFactory(com.qizx.api.fulltext.FullTextFactory)
SHUTDOWN_COMPACTER_DELAY - Static variable in class com.qizx.api.Configuration
Cut-off time on shutdown (closeAllLibraries) granted to cleanup and index optimization tasks.
SieveBase - Class in com.qizx.api.util.text
Base class of Sieve implementations.
SieveBase() - Constructor for class com.qizx.api.util.text.SieveBase
 
size() - Method in class com.qizx.api.fulltext.Thesaurus.LookupResult
Returns the number of equivalent word sequences.
size() - Method in class com.qizx.api.fulltext.Thesaurus.TokenSequence
Returns the number of tokens in the sequence.
size() - Method in interface com.qizx.api.NonXMLDocument
Returns the uncompressed size in bytes of the contained data.
skip(int) - Method in interface com.qizx.api.ItemSequence
Skips items in forward direction.
SPACE_LIMIT - Static variable in exception com.qizx.api.EvaluationException
Error code used when the memory space limit for evaluation has been reached.
STANDALONE - Static variable in class com.qizx.api.util.XMLSerializer
name of option specifying 'standalone' in the XML declaration.
start(char[], int) - Method in interface com.qizx.api.fulltext.TextTokenizer
Starts the analysis of a new text chunk.
start(CharSequence) - Method in interface com.qizx.api.fulltext.TextTokenizer
Starts the analysis of a new text chunk.
start(char[], int) - Method in class com.qizx.api.util.fulltext.DefaultTextTokenizer
 
start(CharSequence) - Method in class com.qizx.api.util.fulltext.DefaultTextTokenizer
 
start(Node) - Method in class com.qizx.api.util.fulltext.FullTextHighlighter
Starts iteration on a Node tree.
start(XMLPullStream) - Method in class com.qizx.api.util.fulltext.FullTextHighlighter
Starts iteration using another XML Stream as source.
start(Node) - Method in class com.qizx.api.util.fulltext.FullTextSnippetExtractor
Searches snippet components in a source XML document or node.
START - Static variable in interface com.qizx.api.XMLPullStream
Value returned by getEvent before the first call to moveToNext.
startDocument() - Method in class com.qizx.api.util.SAXToPushStream
 
startDTD(String, String, String) - Method in class com.qizx.api.util.SAXToPushStream
 
startElement(String, String, String, Attributes) - Method in class com.qizx.api.util.SAXToPushStream
 
startPoint() - Method in class com.qizx.api.admin.Profiling
 
startPrefixMapping(String, String) - Method in class com.qizx.api.util.SAXToPushStream
 
startPut() - Method in class com.qizx.apps.restapi.RestAPIConnection
Starts an import of XML documents.
startPutNonXML() - Method in class com.qizx.apps.restapi.RestAPIConnection
Starts an import of non-XML documents.
startSetProp(String, String, String, String) - Method in class com.qizx.apps.restapi.RestAPIConnection
Starts a batch of setprop operations on a Library Member (document or collection)
STATS_FIELDS - Static variable in interface com.qizx.apps.restapi.RestAPI
 
stem(char[]) - Method in interface com.qizx.api.fulltext.Stemmer
Computes a stem from a word token.
Stemmer - Interface in com.qizx.api.fulltext
Produces a stem from a word.
streamingPut(InputStream) - Method in class com.qizx.apps.restapi.RestAPIConnection
Store wrapped XML documents.
STRING - Static variable in class com.qizx.api.Indexing
Indexing type for a rule: text fragment directly put to string index if length is less than max-string-length.
stringValue(Object) - Method in class com.qizx.api.Configuration.Property
 
stringValueCompareTo(Node, Collator) - Method in interface com.qizx.api.Node
Compares the string values of two nodes, optionally using a collation.
STRIP_COMMENT - Static variable in class com.qizx.api.util.XMLSerializer
name of option specifying the omission of comments (extension): value is a boolean (false by default) that indicates that comments must be stripped (when set to true).
STRIP_PI - Static variable in class com.qizx.api.util.XMLSerializer
name of option specifying the omission of processing instructions (extension): value is a boolean (false by default) that indicates that PI must be stripped (when set to true).
substituteCode(String, String) - Method in exception com.qizx.api.QizxException
 
SYNC_COMMIT - Static variable in class com.qizx.api.Configuration
Control of file-system sync on each commit for data safety.

© 2010 Axyana Software
A B C D E F G H I J L M N O P Q R S T U V W X