public interface SDXThesaurus extends Thesaurus, DocumentBase
Modifier and Type | Interface and Description |
---|---|
static interface |
SDXThesaurus.ConfigurationNode |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_NAME_SUFFIX
String representation of the thesaurus class name suffix.
|
static java.lang.String |
PACKAGE_QUALNAME
String representation of the thesarus package name (including trailing separator ".").
|
NAMESPACE_PREFIX, NAMESPACE_URI, RELATION_BROADER_TERM, RELATION_BROADER_TERMS, RELATION_EQUIVALENT_TERM, RELATION_NARROWER_TERM, RELATION_PARTIAL_EQIUVALENCE, RELATION_RELATED_TERM, RELATION_SCOPE_NOTE, RELATION_USE, RELATION_USED_FOR
DEFAULT_ENCODING
ALL_SAVE_ATTRIB, PATH_ATTRIB, SAVE_DIRECTORY_PARAM
Modifier and Type | Method and Description |
---|---|
void |
addConcept(Concept concept)
Adds a document.
|
void |
addConcepts(Concept[] concepts)
Adds a group of documents.
|
void |
build(org.xml.sax.InputSource source)
Builds a thesaurus from a SAX input source.
|
void |
build(java.lang.String url)
Builds a thesaurus from a File.
|
void |
deleteConcept(Concept concept)
Remove a document.
|
void |
deleteConcepts(Concept[] concepts)
Remove a group of documents.
|
Results |
expandQuery(Query query)
Expands a query returning the results of the expanded query
|
Results |
expandQuery(Query query,
java.lang.String fieldName)
Expands a query returning the results of the expanded query
|
Results |
expandQuery(Query query,
java.lang.String fieldName,
int[] relations,
int depth)
Expands a query returning the results of the expanded query
|
Results |
expandQuery(Query query,
java.lang.String fieldName,
int[] relations,
int depth,
java.lang.String[] langs)
Expands a query returning the results of the expanded query
|
Results |
expandQuery(Query query,
java.lang.String fieldName,
int relation,
int depth)
Expands a query returning the results of the expanded query
|
Concept[] |
filterByLangs(Concept[] concepts,
java.lang.String[] langs)
Filters concepts by a list of languages
|
Concept |
getConceptById(java.lang.String id)
Returns a document using its id.
|
Concept |
getConceptByName(java.lang.String name)
Returns a document using its name.
|
int |
getDefaultDepth()
Return's the default depth for searching relations
|
int[] |
getDefaultRelations()
Return's the default set of relation int's for searching relations
|
Concept[] |
getRelations(Concept concept)
Return's related concepts
|
Concept[] |
getRelations(Concept[] concepts)
Returns related concepts
|
Concept[] |
getRelations(Concept[] concepts,
int[] relations,
int depth)
Finds concepts for matching relations at a given depth
|
Concept[] |
getRelations(Concept[] concepts,
int[] relations,
int depth,
java.lang.String[] langs) |
Concept[] |
getRelations(Concept[] concepts,
int relation,
int depth)
Finds concepts for matching relations at a given depth
|
Concept[] |
getRelations(Concept[] concepts,
int relation,
int depth,
java.lang.String[] langs) |
Concept[] |
getRelations(Concept concept,
int[] relations,
int depth)
Finds concepts for matching relations at a given depth
|
Concept[] |
getRelations(Concept concept,
int[] relations,
int depth,
java.lang.String[] langs) |
Concept[] |
getRelations(Concept concept,
int relation,
int depth)
Finds concepts for matching relations at a given depth
|
Concept[] |
getRelations(Concept concept,
int relation,
int depth,
java.lang.String[] langs) |
Concept[] |
getRelations(java.lang.String searchTerm,
Concept[] concepts,
int[] relations,
int depth)
Finds concepts for matching relations at a given depth
|
Concept[] |
getRelations(java.lang.String searchTerm,
Concept[] concepts,
int relation,
int depth)
Finds concepts for matching relations at a given depth
|
Concept[] |
getRelations(java.lang.String searchTerm,
Concept concept,
int[] relations,
int depth)
Finds concepts for matching relations at a given depth
|
Concept[] |
getRelations(java.lang.String searchTerm,
Concept concept,
int relation,
int depth)
Finds concepts for matching relations at a given depth
|
void |
init()
Initializes the document base.
|
void |
load()
Loads a thesaurus in memory (later).
|
void |
save()
Saves the contents.
|
Concept[] |
search(java.lang.String term)
Searches for concepts.
|
long |
size()
Returns the number of terms in the thesaurus.
|
void |
unload()
Unloads the memory representation of the thesaurus (later).
|
compile, getRelationTypeAbbreviation, getRelationTypeInt
checkIntegrity, createOAIRepository, creationDate, delete, delete, getDefaultHitsPerPage, getDefaultMaxSort, getDefaultRepository, getDocument, getDocument, getDocument, getDocument, getIndexationPipeline, getMimeType, getOAIHarvester, getOAIRepositoriesSize, getOAIRepository, getOAIRepository, getRepository, getSourceValidity, index, index, isDefault, lastModificationDate, optimize
getId, setId
getDescription, setDescription
getEncoding, setEncoding
getLocale, getXmlLang, setLocale, setXmlLang
getId, getIndex
static final java.lang.String PACKAGE_QUALNAME
static final java.lang.String CLASS_NAME_SUFFIX
void init() throws SDXException, org.apache.avalon.framework.configuration.ConfigurationException
DocumentBase
This method must be called after the super.getLog() has been set and the configuration done.
init
in interface DocumentBase
SDXException
org.apache.avalon.framework.configuration.ConfigurationException
void build(java.lang.String url) throws SDXException, org.apache.avalon.framework.configuration.ConfigurationException
url
- The url to the file containing the thesaurus.SDXException
org.apache.avalon.framework.configuration.ConfigurationException
void build(org.xml.sax.InputSource source) throws SDXException
source
- The SAX input source where the thesaurus is.SDXException
long size()
void save()
void load()
void unload()
void addConcept(Concept concept) throws SDXException
concept
- The document to add.SDXException
void addConcepts(Concept[] concepts) throws SDXException
concepts
- The documents to add.SDXException
void deleteConcept(Concept concept) throws SDXException
concept
- The document.SDXException
void deleteConcepts(Concept[] concepts) throws SDXException
concepts
- The documents.SDXException
Concept[] search(java.lang.String term) throws SDXException
term
- The concept term.SDXException
Concept getConceptByName(java.lang.String name) throws SDXException
name
- The document's name.SDXException
Concept getConceptById(java.lang.String id) throws SDXException
id
- The document's id.SDXException
Results expandQuery(Query query) throws SDXException
query
- The query object which should be expanded using this thesaurusSDXException
Results expandQuery(Query query, java.lang.String fieldName) throws SDXException
query
- The query object which should be expanded using this thesaurusfieldName
- The name of field on which expansion should take placeSDXException
Results expandQuery(Query query, java.lang.String fieldName, int relation, int depth) throws SDXException
query
- The query object which should be expanded using this thesaurusfieldName
- The name of field on which expansion should take placerelation
- The relation type, for finding terms which should be used to expand the querydepth
- The depth to which a relation should be followed, 0 finds the relation withing the matching concept
1, finds the relation within concept for the matching relation found by the "0 case", etc.SDXException
Results expandQuery(Query query, java.lang.String fieldName, int[] relations, int depth) throws SDXException
query
- The query object which should be expanded using this thesaurusfieldName
- The name of field on which expansion should take placerelations
- The relation types, for finding terms which should be used to expand the querydepth
- The depth to which a relation should be followed, 0 finds the relation withing the matching concept
1, finds the relation within concept for the matching relation found by the "0 case", etc. * @return A results object of the executed expanded querySDXException
Results expandQuery(Query query, java.lang.String fieldName, int[] relations, int depth, java.lang.String[] langs) throws SDXException
query
- The query object which should be expanded using this thesaurusfieldName
- The name of field on which expansion should take placerelations
- The relation types, for finding terms which should be used to expand the querydepth
- The depth to which a relation should be followed, 0 finds the relation withing the matching concept
1, finds the relation within concept for the matching relation found by the "0 case", etc. * @return A results object of the executed expanded querySDXException
Concept[] getRelations(Concept concept, int relation, int depth) throws SDXException
concept
- The concept from which relations should be usedrelation
- The relation type to search for with a conceptdepth
- The depth to which a relation should be evaluated, 0 finds the relation withing the matching concept
1, finds the relation within concept for the matching relation found by the "0 case", etc.SDXException
Concept[] getRelations(Concept[] concepts, int[] relations, int depth) throws SDXException
concepts
- The concepts from which relations should be usedrelations
- The relation types to search for with a conceptdepth
- The depth to which a relation should be evaluated, 0 finds the relation withing the matching concept
1, finds the relation within concept for the matching relation found by the "0 case", etc.SDXException
Concept[] getRelations(Concept concept, int[] relations, int depth) throws SDXException
concept
- The concept from which relations should be usedrelations
- The relation types to search for with a conceptdepth
- The depth to which a relation should be evaluated, 0 finds the relation withing the matching concept
1, finds the relation within concept for the matching relation found by the "0 case", etc.SDXException
Concept[] getRelations(Concept[] concepts, int relation, int depth) throws SDXException
concepts
- The concepts from which relations should be usedrelation
- The relation type to search for with a conceptdepth
- The depth to which a relation should be evaluated, 0 finds the relation withing the matching concept
1, finds the relation within concept for the matching relation found by the "0 case", etc.SDXException
Concept[] getRelations(java.lang.String searchTerm, Concept[] concepts, int relation, int depth) throws SDXException
searchTerm
- The search term which was used to find the provided conceptsconcepts
- The concepts from which relations should be usedrelation
- The relation type to search for with a conceptdepth
- The depth to which a relation should be evaluated, 0 finds the relation withing the matching concept
1, finds the relation within concept for the matching relation found by the "0 case", etc.SDXException
Concept[] getRelations(java.lang.String searchTerm, Concept[] concepts, int[] relations, int depth) throws SDXException
searchTerm
- The search term which was used to find the provided conceptsconcepts
- The concepts from which relations should be usedrelations
- The relation types to search for with a conceptdepth
- The depth to which a relation should be evaluated, 0 finds the relation withing the matching concept
1, finds the relation within concept for the matching relation found by the "0 case", etc.SDXException
Concept[] getRelations(java.lang.String searchTerm, Concept concept, int relation, int depth) throws SDXException
searchTerm
- The search term which was used to find the provided conceptconcept
- The concept from which relations should be usedrelation
- The relation type to search for with a conceptdepth
- The depth to which a relation should be evaluated, 0 finds the relation withing the matching concept
1, finds the relation within concept for the matching relation found by the "0 case", etc.SDXException
Concept[] getRelations(java.lang.String searchTerm, Concept concept, int[] relations, int depth) throws SDXException
searchTerm
- The search term which was used to find the provided conceptsconcept
- The concepts from which relations should be usedrelations
- The relation types to search for with a conceptdepth
- The depth to which a relation should be evaluated, 0 finds the relation withing the matching concept
1, finds the relation within concept for the matching relation found by the "0 case", etc.SDXException
Concept[] getRelations(Concept concept, int[] relations, int depth, java.lang.String[] langs) throws SDXException
SDXException
Concept[] getRelations(Concept[] concepts, int[] relations, int depth, java.lang.String[] langs) throws SDXException
SDXException
Concept[] getRelations(Concept concept, int relation, int depth, java.lang.String[] langs) throws SDXException
SDXException
Concept[] getRelations(Concept[] concepts, int relation, int depth, java.lang.String[] langs) throws SDXException
SDXException
Concept[] getRelations(Concept[] concepts) throws SDXException
concepts
- The concepts for which relations are desiredSDXException
Concept[] getRelations(Concept concept) throws SDXException
concept
- The concept for which relations are desiredSDXException
int getDefaultDepth()
int[] getDefaultRelations()
Copyright © 2000-2010 Ministere de la culture et de la communication / AJLSM. All Rights Reserved.