org.eaglei.search.provider.lucene
Class LuceneSearchIndexSchema

java.lang.Object
  org.eaglei.search.provider.lucene.LuceneSearchIndexSchema

Direct Known Subclasses:

LuceneQueryBuilder, LuceneSearchProvider, LuceneSearchProviderIndexer

public class LuceneSearchIndexSchema
extends java.lang.Object

Holds information about the schema for the Lucene index used to support search over eagle-i RDF resource data. This index is populated from the RDF data by creating a Lucene document for each eagle-i "resource" (or subject RDF resource whose type is a subclass of the "resource" types). Each of these documents contains fields for the direct resource data type and object properties as well as fields corresponding to indirect relationships: inferred types and textual descriptions of resource related by object properties. The following fixed field names are supported (see Javadocs below for details):

• uri
• resourceFlag
• related
• pref_text
• text
• inferredType
• institution_uri
• institution_label

The following variable field names are supported:

• : The text value for each object and datatype property is stored in a multi-valued field using the property URI. Stored, indexed and analyzed. For data type properties, the value is the property value. For object properties, the value is the label of the property resource.
• _uri: For object properties, this holds the resource URI in a multi-valued field. Stored and indexed.

Author:

frost

Field Summary

static float	HIGH_BOOST High boost
static float	HIGHEST_BOOST Highest boost
static boolean	INDEX_OBJECT_PROP_LABELS Flag that controls whether the preferred labels of object properties are indexed/updated
static java.lang.String	INFERRED_TYPE Multi-valued field that holds the URIs of all inferred classes.
static java.lang.String	INSTITUTION_LABEL Holds the name of the institution.
static java.lang.String	INSTITUTION_URI Holds the URI of the institution.
static float	LOW_BOOST Boost value for fields that should be should be given a lower than normal boost.
static float	MEDIUM_BOOST Medium boost
static java.lang.String	OBJECT_URI_POSTFIX Suffix for fields that are used to represent object properties.
static java.lang.String	PREF_TEXT Multi-valued field that holds the lexical form of all preferred datatype properties.
static java.lang.String	RELATED Multi-valued field that holds the URIs of all object properties.
static java.lang.String	RESOURCE_FLAG Field that holds a boolean value indicating whether the resource is an eagle-i resource (i.e.
static float	STANDARD_BOOST Standard boost
static java.lang.String	TEXT Multi-valued field that holds the lexical form of preferred datatype properties, non-preferred datatype properties and preferred datatype props of resource related by object props.
static java.lang.String	URI The unique URI of the resource.

Constructor Summary

LuceneSearchIndexSchema()

Method Summary

protected static boolean	isLabProperty(java.lang.String uri) Checks if the specified property represents a property that associates a resource with a lab
protected static boolean	isPropertyField(java.lang.String fieldName) Checks if the Lucene document field represents a data type or object property

Methods inherited from class java.lang.Object

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

Field Detail

URI

public static final java.lang.String URI

The unique URI of the resource. Stored and indexed but not analyzed.

See Also:

Constant Field Values

RESOURCE_FLAG

public static final java.lang.String RESOURCE_FLAG

Field that holds a boolean value indicating whether the resource is an eagle-i resource (i.e. subclass of a top-level resource) or an instance of a non-resource class (e.g. technique). Stored and indexed but not analyzed.

See Also:

Constant Field Values

RELATED

public static final java.lang.String RELATED

Multi-valued field that holds the URIs of all object properties. Stored and indexed but not analyzed.

See Also:

Constant Field Values

PREF_TEXT

public static final java.lang.String PREF_TEXT

Multi-valued field that holds the lexical form of all preferred datatype properties. A boost is given to this field. Stored, indexed and analyzed.

See Also:

Constant Field Values

TEXT

public static final java.lang.String TEXT

Multi-valued field that holds the lexical form of preferred datatype properties, non-preferred datatype properties and preferred datatype props of resource related by object props. Stored, indexed and analyzed.

See Also:

Constant Field Values

INFERRED_TYPE

public static final java.lang.String INFERRED_TYPE

Multi-valued field that holds the URIs of all inferred classes. Stored and indexed but not analyzed.

See Also:

Constant Field Values

INSTITUTION_URI

public static final java.lang.String INSTITUTION_URI

Holds the URI of the institution. Stored and indexed but not analyzed.

See Also:

Constant Field Values

INSTITUTION_LABEL

public static final java.lang.String INSTITUTION_LABEL

Holds the name of the institution. Stored, indexed and analyzed.

See Also:

Constant Field Values

OBJECT_URI_POSTFIX

public static final java.lang.String OBJECT_URI_POSTFIX

Suffix for fields that are used to represent object properties.

See Also:

Constant Field Values

LOW_BOOST

public static final float LOW_BOOST

Boost value for fields that should be should be given a lower than normal boost.

See Also:

Constant Field Values

STANDARD_BOOST

public static final float STANDARD_BOOST

Standard boost

See Also:

Constant Field Values

MEDIUM_BOOST

public static final float MEDIUM_BOOST

Medium boost

See Also:

Constant Field Values

HIGH_BOOST

public static final float HIGH_BOOST

High boost

See Also:

Constant Field Values

HIGHEST_BOOST

public static final float HIGHEST_BOOST

Highest boost

See Also:

Constant Field Values

INDEX_OBJECT_PROP_LABELS

public static final boolean INDEX_OBJECT_PROP_LABELS

Flag that controls whether the preferred labels of object properties are indexed/updated

See Also:

Constant Field Values

Constructor Detail

LuceneSearchIndexSchema

public LuceneSearchIndexSchema()

Method Detail

isPropertyField

protected static boolean isPropertyField(java.lang.String fieldName)

Checks if the Lucene document field represents a data type or object property

isLabProperty

protected static boolean isLabProperty(java.lang.String uri)

Checks if the specified property represents a property that associates a resource with a lab

Parameters:

uri - URI of property

Returns:

True if it binds a resource to a lab.