edu.cornell.mannlib.vitro.webapp.searchindex.extensions

Class LabelsAcrossContextNodes

java.lang.Object

edu.cornell.mannlib.vitro.webapp.searchindex.extensions.LabelsAcrossContextNodes

All Implemented Interfaces:

DocumentModifier, IndexingUriFinder, ContextModelsUser

public class LabelsAcrossContextNodes
extends Object
implements IndexingUriFinder, DocumentModifier, ContextModelsUser

If an individual has context nodes then the search document for that individual should include the labels of the partners across those nodes. The labels will be added to the ALLTEXT and ALLTEXTUNSTEMMED fields. We must specify what property leads to a context node (incoming), and what property leads from a context node (outgoing). We may add restrictions to say that this only applies to individuals of certain types. We may also restrict the type of the applicable context nodes. An instance of this class acts as both a DocumentModifier and an IndexingUriFinder: As a DocumentModifier, it looks across approved context nodes to fetch the labels of the partners. As an IndexingUriFinder, it recognizes that this relationship can be changed by a change to a "label" statement, or to a "relates" property, and finds all partners as candidates for reindexing.

 Configuration:
     rdfs:label -- Optional. Appears in the timings and debug statements.
     :hasIncomingProperty -- Required. Property leading to the context node.
     :hasOutgoingProperty -- Required. Property leading from the context node.
     :hasTypeRestriction -- Optional. Match any. If none, then no restriction.
     :appliesToContextNodeType -- Optional. Match any. If none, then no restriction.
 

Constructor Summary

Constructors

Constructor and Description
LabelsAcrossContextNodes()

Method Summary

Modifier and Type	Method and Description
void	addContextNodeClass(String cnc)
void	addTypeRestriction(String typeUri)
void	endIndexing()
List<String>	findAdditionalURIsToIndex(com.hp.hpl.jena.rdf.model.Statement stmt) If this is a "label" statement, check to see if the subject has any acceptable partners across acceptable context nodes.
void	modifyDocument(Individual ind, SearchInputDocument doc) If this individual is acceptable, locate the labels of any context partners across acceptable context nodes.
void	setContextModels(ContextModelAccess models)
void	setIncomingProperty(String incomingUri)
void	setLabel(String l)
void	setOutgoingProperty(String outgoingUri)
void	shutdown()
void	startIndexing()
String	toString()
void	validate()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LabelsAcrossContextNodes

public LabelsAcrossContextNodes()

Method Detail

setContextModels

public void setContextModels(ContextModelAccess models)

Specified by:

setContextModels in interface ContextModelsUser

setLabel

public void setLabel(String l)

setIncomingProperty

public void setIncomingProperty(String incomingUri)

setOutgoingProperty

public void setOutgoingProperty(String outgoingUri)

addTypeRestriction

public void addTypeRestriction(String typeUri)

addContextNodeClass

public void addContextNodeClass(String cnc)

validate

public void validate()

toString

public String toString()

Overrides:

toString in class Object

modifyDocument

public void modifyDocument(Individual ind,
                           SearchInputDocument doc)

If this individual is acceptable, locate the labels of any context partners across acceptable context nodes. Add those labels to the text fields of the search document.

Specified by:

modifyDocument in interface DocumentModifier

shutdown

public void shutdown()

Specified by:

shutdown in interface DocumentModifier

startIndexing

public void startIndexing()

Specified by:

startIndexing in interface IndexingUriFinder

findAdditionalURIsToIndex

public List<String> findAdditionalURIsToIndex(com.hp.hpl.jena.rdf.model.Statement stmt)

If this is a "label" statement, check to see if the subject has any acceptable partners across acceptable context nodes. If this is a statement that involves the specified incoming property on an acceptable context node, check to see if there are any acceptable partners on this node.

Specified by:

findAdditionalURIsToIndex in interface IndexingUriFinder

endIndexing

public void endIndexing()

Specified by:

endIndexing in interface IndexingUriFinder