Bug 329976

Description Jan Koehnlein 2010-11-11 04:16:40 EST

I'd like to open a discussion on the naming of some classes in the index API.
I know that this is a central API and renaming could break lot of things, but working with the index data model sometimes becomes a bit tedious due to the naming.

1) IResourceDescription, IReferenceDescripton, and IResourceDescriptions look almost the same (did you notice the difference while reading this?) and it is likely they are all used within the same context. This becomes especially annoying when using code assist.

2) The term 'index' does not appear in any name of the framework classes nor packages even though we use it a lot when talking about that API.

3) While its purpose is to store the configuration of all IContainers, the most prominent purpose of the IAllContainersState for our clients is to manage container (project) dependencies. Given that, this interface is pretty hard to find.

4) IResourceDescription.Manager is a factory and a dependency manager. From my experience, clients mostly touch it as the entry hook to configure what is indexed. Coming from that side I wouldn't find it. Maybe we should extract the factory part to a IResourceDescription.Factory.

Suggestions
- IResourceDescription stay the same
- IReferenceDescription -> ICrossReferenceDescription 
- IResourceDescription -> IIndex(State)
- IAllContainersState -> IContainerIndex

What do you think?