|
Qizx fe-4.4p2 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface XQuerySession
Simple XQuery session without access to XML Libraries, used in Qizx/open.
Field Summary | |
---|---|
static String |
ALLOWED_JAVA_CLASSES
|
Method Summary | |
---|---|
Expression |
compileExpression(String xquery)
Creates an executable Expression by compiling a XQuery script. |
void |
enableJavaBinding(String className)
Enables a class for the 'Java Binding' mechanism. |
XQueryContext |
getContext()
Access to the default XQuery Context. |
FullTextFactory |
getFullTextFactory()
Returns the Fulltext Provider associated with the session. |
int |
getIdentifier()
Returns a unique identifier of the session. |
ModuleResolver |
getModuleResolver()
Returns the private module resolver defined for the session. |
Indexing.WordSieve |
getWordSieve()
Deprecated. see getFullTextFactory() setFullTextFactory(com.qizx.api.fulltext.FullTextFactory) |
List<Expression> |
listExpressions()
Returns a list of expressions compiled from this session. |
void |
setFullTextFactory(FullTextFactory fulltextProvider)
Redefines the full-text factory associated with the session. |
void |
setModuleResolver(ModuleResolver resolver)
Defines a private Module resolver for the session. |
void |
setWordSieve(Indexing.WordSieve wordSieve)
Deprecated. see setFullTextFactory(com.qizx.api.fulltext.FullTextFactory) |
Methods inherited from interface com.qizx.api.ItemFactory |
---|
copySequence, createItem, createItem, createItem, createItem, createItem, createItem, createItem, createSequence, getNodeType, getQName, getQName, getQName, getType |
Field Detail |
---|
static final String ALLOWED_JAVA_CLASSES
Method Detail |
---|
XQueryContext getContext()
int getIdentifier()
Expression compileExpression(String xquery) throws CompilationException
xquery
- a string containing a XQuery script.
CompilationException
- thrown after compilation if parsing or
static analysis errors are detected. A CompilationException bears a list
of Message
s.List<Expression> listExpressions()
void setModuleResolver(ModuleResolver resolver)
resolver
- a Module resolver; if set to null, the default module
resolver will then be used for the sessionModuleResolver getModuleResolver()
void setWordSieve(Indexing.WordSieve wordSieve) throws DataModelException
setFullTextFactory(com.qizx.api.fulltext.FullTextFactory)
DefaultWordSieve
.
DataModelException
- if the session is in fact an XML Library,
changing the word sieve can generate an exception (for example if it
is read-only).Indexing.WordSieve getWordSieve()
getFullTextFactory()
setFullTextFactory(com.qizx.api.fulltext.FullTextFactory)
DefaultWordSieve
void enableJavaBinding(String className)
Attention: the Java Binding mechanism is not enabled by default when using the API. Each Java class has to be enabled specifically. It is possible to enable all classes at once (though not advisable for security reasons) by passing a null name.
Attention: once a class has been enabled, it can no longer be disabled in the same session.
className
- fully qualified class name (e.g
java.sql.DriverManager). If the value 'null' is used instead of a
class name, then all Java to Java extensions are
enabled or disabled.void setFullTextFactory(FullTextFactory fulltextProvider)
A FullTextFactory provides access to- or allows redefining full-text resources such as text tokenizer, stemming, thesaurus and scoring method.
By default, an instance of DefaultFullTextFactory
is used. It
is also possible to define a FullTextFactory on the LibraryManager
which controls a group of Libraries.
fulltextProvider
- a new Fulltext Provider.FullTextFactory getFullTextFactory()
|
© 2010 Axyana Software | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |