|
Qizx/open 4.1 API | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.qizx.api.Indexing.Rule
public static class Indexing.Rule
Indexing properties associated with an element or an attribute (for advanced indexing).
A Rule can have a context, which is a list of QNames of enclosing elements. If a context is defined the Rule is applicable only if the enclosing elements match the context. Default rules have a null context.
| Constructor Summary | |
|---|---|
Indexing.Rule(QName name,
QName[] context,
int indexingType)
Constructs a Rule for an element or for an attribute. |
|
| Method Summary | |
|---|---|
QName[] |
getContext()
Returns the element context constraint. |
int |
getContextDepth()
Returns the element context depth. |
byte |
getFullText()
Returns TRUE, FALSE, or INHERIT if full-text indexing is applied to the element matched by this rule. |
int |
getIndexingType()
Gets the indexes targeted by this rule (STRING, NUMERIC, DATE or combination). |
QName |
getName()
Returns the name of the element or attribute concerned by the rule. |
Indexing.NumberSieve |
getSieve()
Returns the Numeric or Date Sieve associated with the rule. |
boolean |
precedes(Indexing.Rule rule)
Returns true if this rule is more specific than the rule in argument |
void |
setContext(QName[] context)
Defines an optional context of ancestors to be matched. |
void |
setDefaultSieve()
Sets a default Sieve according to the indexing type. |
void |
setFullText(byte fulltext)
Specifies whether full-text indexing is applied to the element matched by this rule and to its descendants. |
void |
setIndexingType(int indexingType)
Sets the indexxes targeted by this rule. |
void |
setName(QName name)
Defines the name of the element/attribute concerned by the rule. |
void |
setSieve(Indexing.NumberSieve sieve)
Defines the Numeric or Date Sieve associated with the rule. |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public Indexing.Rule(QName name,
QName[] context,
int indexingType)
name - name of the element or attributecontext - enclosing elements (optional)indexingType - possible values are STRING, NUMERIC, DATE,
NUMERIC_AND_STRING, DATE_AND_STRING| Method Detail |
|---|
public boolean precedes(Indexing.Rule rule)
public void setDefaultSieve()
public QName[] getContext()
public int getContextDepth()
public void setContext(QName[] context)
context - an array of ancestor names, from outermost to
innermost (parent).public final byte getFullText()
public void setFullText(byte fulltext)
fulltext - possible values are ENABLE_FULL_TEXT,
DISABLE_FULL_TEXT, and INHERIT.public QName getName()
public void setName(QName name)
name - an element or attribute namepublic final Indexing.NumberSieve getSieve()
public void setSieve(Indexing.NumberSieve sieve)
public final int getIndexingType()
public void setIndexingType(int indexingType)
indexingType - STRING, NUMERIC, DATE or combination
|
© 2010 Axyana Software | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||