|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.isogen.indexhelper.IndexHelper
Constructor Summary | |
IndexHelper()
|
|
IndexHelper(java.lang.String configFilename)
Construct new indexHelper with configuration. |
Method Summary | |
java.lang.String |
getGroupKey(java.lang.String langCode,
java.lang.String indexEntry)
Returns the group key for the index group the indexEntry sorts within. |
java.lang.String |
getGroupLabel(java.lang.String langCode,
java.lang.String groupKey)
Given a group key, returns the groups display label string. |
java.lang.String |
getGroupSortKey(java.lang.String langCode,
java.lang.String groupKey)
Given a group key, returns the group sort key, that is, the key that the index style sheet uses to sort the groups in presentation order. |
java.util.Iterator |
getIndexGroupKeysIterator(java.lang.String langCode)
|
void |
loadIndexRuleSetDoc(java.lang.String configFilename)
Loads the specified index configuration file. |
java.lang.String |
printIndexRuleSet(java.lang.String langCode)
|
java.lang.String |
printIndexRuleSet(java.lang.String langCode,
boolean includeCollationRules)
|
java.lang.String |
toString()
|
java.lang.String |
toString(boolean includeCollationRules)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public IndexHelper(java.lang.String configFilename) throws IndexHelperException
public IndexHelper()
Method Detail |
public void loadIndexRuleSetDoc(java.lang.String configFilename) throws IndexHelperException
configFilename
- Filename of the index configuration file.
IndexHelperException
public java.util.Iterator getIndexGroupKeysIterator(java.lang.String langCode) throws IndexHelperException
IndexHelperException
public java.lang.String getGroupKey(java.lang.String langCode, java.lang.String indexEntry) throws IndexHelperException
langCode
- The language code for the output language.indexEntry
- The index entry for which the group key will be provided.
IndexHelperException
public java.lang.String getGroupLabel(java.lang.String langCode, java.lang.String groupKey) throws IndexHelperException
langCode
- The language code for the index configuration.groupKey
- The sort key (as returned by getGroupKey()) for the group.
IndexHelperException
public java.lang.String getGroupSortKey(java.lang.String langCode, java.lang.String groupKey) throws IndexHelperException
langCode
- The language code for the index configuration.groupKey
- The sort key (as returned by getGroupKey()) for the group.
IndexHelperException
public java.lang.String printIndexRuleSet(java.lang.String langCode, boolean includeCollationRules) throws IndexHelperException
IndexHelperException
public java.lang.String printIndexRuleSet(java.lang.String langCode) throws IndexHelperException
IndexHelperException
public java.lang.String toString()
public java.lang.String toString(boolean includeCollationRules)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |