com.ibm.xtools.emf.index.provider

Interface IIndexEntry

All Known Implementing Classes:

AbstractIndexEntry, EObjectEntry, ResourceEntry

Deprecated.

Use the factory methods IIndexWriter.createEObjectEntry(com.ibm.xtools.emf.index.search.IndexContext, org.eclipse.emf.common.util.URI, org.eclipse.emf.ecore.EClass) and IIndexWriter.createResourceEntry(com.ibm.xtools.emf.index.search.IndexContext, org.eclipse.emf.common.util.URI) instead.

public interface IIndexEntry

Represents an indexable entry in the index store. The IIndexProvider creates these entries while parsing/loading the resource. The index provider is invoked for the associated content type to create a collection of these entries corresponding to the EObjects within that resource. Every resource has a ResourceEntry and a collection of EObjectEntrys that correspond to each EObject within the resource. The field names should correspond to the set of fields defined in the IIndexProvider interface. Clients should not implement this interface. Clients should use the ResourceEntry and EObjectEntry classes. Clients should not invoke any method on this interface.

Field Summary

Fields

Modifier and Type	Field and Description
static int	EOBJECT_KIND Deprecated. Entry kind constant indicating associated with eObject infromation
static int	RESOURCE_KIND Deprecated. Entry kind constant indicating associated with resource infromation

Method Summary

Modifier and Type	Method and Description
java.util.Collection<java.lang.String>	getFields() Deprecated. Return the collections of fields.
int	getKind() Deprecated. Returns the kind of entry
java.lang.Object	getValue(java.lang.String field) Deprecated. Return the value the specified field.
boolean	isMultiValued(java.lang.String field) Deprecated. Returns whether the specified field has multiple values or a single value
boolean	isStored(java.lang.String field) Deprecated. Returns whether the value of the specified field is to be stored in the index for return with search results.

Field Detail

RESOURCE_KIND

static final int RESOURCE_KIND

Deprecated.

Entry kind constant indicating associated with resource infromation

See Also:

getKind(), Constant Field Values

EOBJECT_KIND

static final int EOBJECT_KIND

Deprecated.

Entry kind constant indicating associated with eObject infromation

See Also:

getKind(), Constant Field Values

Method Detail

getFields

java.util.Collection<java.lang.String> getFields()

Deprecated.

Return the collections of fields. All the fields are of type java.lang.String

Returns:

The field collection

getValue

java.lang.Object getValue(java.lang.String field)

Deprecated.

Return the value the specified field. The return type is a java.util.Collection of java.lang.Strings if the field is a multi valued field, otherwise it is a java.lang.String

Parameters:

field - The specified field

Returns:

The value for the specified field

isStored

boolean isStored(java.lang.String field)

Deprecated.

Returns whether the value of the specified field is to be stored in the index for return with search results. The value of the field will be indexed, so that it may be searched on

Parameters:

field - The specified field

Returns:

true if value of the field is stored

isMultiValued

boolean isMultiValued(java.lang.String field)

Deprecated.

Returns whether the specified field has multiple values or a single value

Parameters:

field - The specified field

Returns:

true if value of the field is multi-valued

getKind

int getKind()

Deprecated.

Returns the kind of entry

Returns:

RESOURCE_KIND or EOBJECT_KIND