org.dllearner.algorithms.isle.index.semantic

Class SemanticIndex

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<org.semanticweb.owlapi.model.OWLEntity,Set<AnnotatedDocument>>

org.dllearner.algorithms.isle.index.semantic.SemanticIndex

All Implemented Interfaces:

Serializable, Cloneable, Map<org.semanticweb.owlapi.model.OWLEntity,Set<AnnotatedDocument>>, Index

public class SemanticIndex
extends HashMap<org.semanticweb.owlapi.model.OWLEntity,Set<AnnotatedDocument>>
implements Index

Interface for an index which is able to resolve a given entity's URI to the set of documents containing this entity, i.e., documents which contain words disambiguated to the given entity.

Author:

Lorenz Buehmann, Daniel Fleischhacker

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
SemanticIndex()

Method Summary

Modifier and Type	Method and Description
Set<AnnotatedDocument>	getDocuments(org.semanticweb.owlapi.model.OWLEntity entity) Returns the set of annotated documents which reference the given entity using one of its surface forms.
int	getNrOfDocumentsFor(org.semanticweb.owlapi.model.OWLEntity entity) Returns the number of documents for the given entity.
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.
void	setTotalNrOfDocuments(int nrOfDocuments)

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

SemanticIndex

public SemanticIndex()

Method Detail

getDocuments

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

Returns the set of annotated documents which reference the given entity using one of its surface forms.

Specified by:

getDocuments in interface Index

Parameters:

entity - entity to retrieve documents

Returns:

documents referencing given entity

getNrOfDocumentsFor

public int getNrOfDocumentsFor(org.semanticweb.owlapi.model.OWLEntity entity)

Returns the number of documents for the given entity.

Parameters:

entity - entity to return number of referencing documents for

Returns:

number of documents for the given entity in this index

setTotalNrOfDocuments

public void setTotalNrOfDocuments(int nrOfDocuments)

Parameters:

nrOfDocuments - the nrOfDocuments to set

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

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