org.compass.core.spi
Interface InternalResource

All Superinterfaces:
AliasedObject, Resource, Serializable
All Known Subinterfaces:
MultiResource
All Known Implementing Classes:
LuceneMultiResource, LuceneResource

public interface InternalResource
extends Resource

An intenral SPI of Resource.

Author:
kimchy

Method Summary
 void addUID()
          Sets the UID for the resource based on the current ids existing withing the resource and the resource mapping associated with it.
 void attach(SearchEngineFactory searchEngineFactory)
          Attaches the given resource to the search engine factory.
 ResourceKey getResourceKey()
          Returns the resource key associated with this resource.
 ResourceMapping getResourceMapping()
          Returns the resource mapping associated with this resource.
 String getSubIndex()
          Returns the sub index this resource is associated with.
 
Methods inherited from interface org.compass.core.Resource
addProperty, addProperty, addProperty, copy, getAlias, getBoost, getId, getIdProperties, getIdProperty, getIds, getObject, getObjects, getProperties, getProperties, getProperty, getUID, getValue, getValues, removeProperties, removeProperty, setBoost, setProperty, setProperty, setProperty
 

Method Detail

getResourceKey

ResourceKey getResourceKey()
Returns the resource key associated with this resource.


getResourceMapping

ResourceMapping getResourceMapping()
Returns the resource mapping associated with this resource.


getSubIndex

String getSubIndex()
Returns the sub index this resource is associated with.


addUID

void addUID()
Sets the UID for the resource based on the current ids existing withing the resource and the resource mapping associated with it.


attach

void attach(SearchEngineFactory searchEngineFactory)
Attaches the given resource to the search engine factory.



Copyright (c) 2004-2009 The Compass Project.