org.dllearner.algorithms.isle.index.syntactic

Class LuceneSyntacticIndex

java.lang.Object

org.dllearner.algorithms.isle.index.syntactic.LuceneSyntacticIndex

All Implemented Interfaces:

Index

public class LuceneSyntacticIndex
extends Object
implements Index

Author:

Lorenz Buehmann

Constructor Summary

Constructors

Constructor and Description
LuceneSyntacticIndex(org.semanticweb.owlapi.model.OWLOntology ontology, org.apache.lucene.store.Directory directory, String searchField)
LuceneSyntacticIndex(org.semanticweb.owlapi.model.OWLOntology ontology, org.apache.lucene.index.IndexReader indexReader, String searchField)
LuceneSyntacticIndex(org.semanticweb.owlapi.model.OWLOntology ontology, String indexDirectory, String searchField)

Method Summary

Modifier and Type	Method and Description
Set<TextDocument>	getAllDocuments()
Set<AnnotatedDocument>	getDocuments(org.semanticweb.owlapi.model.OWLEntity entity) Returns a set of documents based on how the underlying index is processing the given search string.
long	getNumberOfDocumentsFor(org.semanticweb.owlapi.model.OWLEntity... entities) Returns a set of documents based on how the underlying index is processing the given search string.
long	getNumberOfDocumentsFor(org.semanticweb.owlapi.model.OWLEntity entity) Returns a set of documents based on how the underlying index is processing the given search string.
long	getTotalNumberOfDocuments() Returns the total number of documents contained in the index.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LuceneSyntacticIndex

public LuceneSyntacticIndex(org.semanticweb.owlapi.model.OWLOntology ontology,
                            org.apache.lucene.index.IndexReader indexReader,
                            String searchField)

LuceneSyntacticIndex

public LuceneSyntacticIndex(org.semanticweb.owlapi.model.OWLOntology ontology,
                            org.apache.lucene.store.Directory directory,
                            String searchField)
                     throws Exception

Throws:

Exception

LuceneSyntacticIndex

public LuceneSyntacticIndex(org.semanticweb.owlapi.model.OWLOntology ontology,
                            String indexDirectory,
                            String searchField)
                     throws Exception

Throws:

Exception

Method Detail

getDocuments

public Set<AnnotatedDocument> getDocuments(org.semanticweb.owlapi.model.OWLEntity entity)

Description copied from interface: Index

Returns a set of documents based on how the underlying index is processing the given search string.

Specified by:

getDocuments in interface Index

Parameters:

entity - Entity specifying the documents to retrieve

Returns:

set of documents retrieved based on the given query string

getTotalNumberOfDocuments

public long getTotalNumberOfDocuments()

Description copied from interface: Index

Returns the total number of documents contained in the index.

Specified by:

getTotalNumberOfDocuments in interface Index

Returns:

the total number of documents contained in the index

getAllDocuments

public Set<TextDocument> getAllDocuments()

getNumberOfDocumentsFor

public long getNumberOfDocumentsFor(org.semanticweb.owlapi.model.OWLEntity entity)

Description copied from interface: Index

Returns a set of documents based on how the underlying index is processing the given search string.

Specified by:

getNumberOfDocumentsFor in interface Index

Parameters:

entity - Entity specifying the documents to retrieve

Returns:

set of documents retrieved based on the given query string

getNumberOfDocumentsFor

public long getNumberOfDocumentsFor(org.semanticweb.owlapi.model.OWLEntity... entities)

Description copied from interface: Index

Returns a set of documents based on how the underlying index is processing the given search string.

Specified by:

getNumberOfDocumentsFor in interface Index

Parameters:

entities - Entities specifying the documents to retrieve

Returns:

set of documents retrieved based on the given query string