com.ibm.xtools.emf.index.provider

Interface IEObjectEntry

All Superinterfaces:

IEntry

public interface IEObjectEntry
extends IEntry

An entry interface for capturing the EObject information. This class should be used by clients who extend the AbstractIndexProvider to create index entries for each eObject within the resource. This interface should not be implemented by clients.

Since:

7.6

See Also:

IIndexWriter.createEObjectEntry(com.ibm.xtools.emf.index.search.IndexContext, URI, EClass)

Method Summary

Modifier and Type	Method and Description
void	addEAttributeValue(org.eclipse.emf.ecore.EAttribute attribute, java.lang.Object value) Adds a new value for an EObject for this EObject entry.
void	addEReferenceValue(org.eclipse.emf.ecore.EReference reference, org.eclipse.emf.common.util.URI refURI) Adds a new EReference value for this EObject entry.
org.eclipse.emf.ecore.EClass	getEClass() Retrieve the EClass for this EObject.
org.eclipse.emf.common.util.URI	getEObjectContainerURI() Retrieve the URI of the container of this EObject.
org.eclipse.emf.common.util.URI	getEObjectURI() Retrieve the EObject URI for the entry.
void	setContainerURI(org.eclipse.emf.common.util.URI containerURI) Sets the EObject's container URI.
void	setEObjectURI(org.eclipse.emf.common.util.URI objectURI) Sets the EObject URI.

Methods inherited from interface com.ibm.xtools.emf.index.provider.IEntry

getContext

Method Detail

getEClass

org.eclipse.emf.ecore.EClass getEClass()

Retrieve the EClass for this EObject. The EClass is the one provided by the call to the factory method IIndexWriter.createEObjectEntry(com.ibm.xtools.emf.index.search.IndexContext, URI, EClass).

Returns:

The EClass for this EObject entry.

getEObjectURI

org.eclipse.emf.common.util.URI getEObjectURI()

Retrieve the EObject URI for the entry. This is the URI provided by any calls to setEObjectURI(URI) or is null if the EObject URI is not set.

Returns:

The URI for this EObject entry.

getEObjectContainerURI

org.eclipse.emf.common.util.URI getEObjectContainerURI()

Retrieve the URI of the container of this EObject. The URI is the one provided by the call to the factory method IIndexWriter.createEObjectEntry(com.ibm.xtools.emf.index.search.IndexContext, URI, EClass).

Returns:

The URI for the container of this EObject entry.

addEAttributeValue

void addEAttributeValue(org.eclipse.emf.ecore.EAttribute attribute,
                        java.lang.Object value)

Adds a new value for an EObject for this EObject entry. The value should not be null and should be the string value of the value. The EAttribute should be checked to see if it is indexed using IIndexConfigurationManager.isFeatureIndexed(EAttribute).

Parameters:

attribute - A valid EAttribute on this EObject.

value - A non-null string value for the attribute.

addEReferenceValue

void addEReferenceValue(org.eclipse.emf.ecore.EReference reference,
                        org.eclipse.emf.common.util.URI refURI)

Adds a new EReference value for this EObject entry. The refURI should not be null and should be fully normalized using IndexContext.normalize(URI, org.eclipse.emf.ecore.resource.ResourceSet). This method can (and should) be called multiple times for the same EReference if there is more than one reference.

Parameters:

reference - A valid EReference on this EObject.

refURI - A non-null URI value for this EReference.

setEObjectURI

void setEObjectURI(org.eclipse.emf.common.util.URI objectURI)

Sets the EObject URI. This method must be invoked exactly once for each EObject entry. This URI should not be null and should be fully normalized using IndexContext.normalize(URI, org.eclipse.emf.ecore.resource.ResourceSet).

Parameters:

objectURI - A non-null URI value for this EObject.

setContainerURI

void setContainerURI(org.eclipse.emf.common.util.URI containerURI)

Sets the EObject's container URI. This method should be invoked if and only if the container URI was not provided to the factory method IIndexWriter.createEObjectEntry(IndexContext, URI, EClass). This URI should not be null and should be fully normalized using IndexContext.normalize(URI, org.eclipse.emf.ecore.resource.ResourceSet).

Parameters:

containerURI - A non-null URI value for the container of this EObject.