com.sun.labs.minion
Interface Indexable

All Known Implementing Classes:

IndexableMap

public interface Indexable

An interface that should be implemented by things that are indexable.

Method Summary

java.lang.String	getKey() Gets the unique key associated with this indexable object.
java.util.Map<java.lang.String,java.lang.Object>	getMap() Gets the map from field names to field values associated with this indexable object.

Method Detail

getKey

java.lang.String getKey()

Gets the unique key associated with this indexable object.

Returns:

the unique key associated with this object.

getMap

java.util.Map<java.lang.String,java.lang.Object> getMap()

Gets the map from field names to field values associated with this indexable object.

Returns:

a map from field names to field values. If there was some problem generating the map, null can be returned and the indexer will ignore this document.