com.lucidworks.apollo.component

Class CollectionComponent

java.lang.Object

<any>

com.lucidworks.apollo.component.ItemCache<com.lucidworks.apollo.common.models.Collection>

com.lucidworks.apollo.component.CollectionComponent

public class CollectionComponent
extends ItemCache<com.lucidworks.apollo.common.models.Collection>

Does basic data reading involving collections. Caches the results internally.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CollectionComponent.CollectionChangeAware

Constructor Summary

Constructors

Constructor and Description
CollectionComponent(CuratorComponent curator, MetricRegistry metricRegistry, ObjectMapper mapper)

Method Summary

Modifier and Type	Method and Description
void	addCollectionChangeListener(CollectionComponent.CollectionChangeAware listener)
static <any>	getAppName(java.lang.String collectionId, com.lucidworks.apollo.links.LinkManager linkManager) Get the app name (or more correctly the ID) that a collection is associated with, if possible.
<any>	getCollection(java.lang.String id)
int	getTotalCollectionCount() This returns the number of collections *that are registered in Apollo.*.
boolean	hasCollection(java.lang.String collectionId)
java.util.Collection<com.lucidworks.apollo.common.models.Collection>	listCollections()

Methods inherited from class com.lucidworks.apollo.component.ItemCache

curatorAvailable, shutdown

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CollectionComponent

public CollectionComponent(CuratorComponent curator,
                           MetricRegistry metricRegistry,
                           ObjectMapper mapper)

Method Detail

listCollections

public java.util.Collection<com.lucidworks.apollo.common.models.Collection> listCollections()
                                                                                     throws java.io.IOException

Throws:

java.io.IOException

hasCollection

public boolean hasCollection(java.lang.String collectionId)

getCollection

public <any> getCollection(java.lang.String id)
                    throws java.io.IOException

Throws:

java.io.IOException

getTotalCollectionCount

public int getTotalCollectionCount()
                            throws SolrAPIException,
                                   java.io.IOException

This returns the number of collections *that are registered in Apollo.*. Not the total number of collections in all the Solr instances Apollo knows about.

Returns:

Throws:

SolrAPIException

java.io.IOException

addCollectionChangeListener

public void addCollectionChangeListener(CollectionComponent.CollectionChangeAware listener)

getAppName

public static <any> getAppName(java.lang.String collectionId,
                               com.lucidworks.apollo.links.LinkManager linkManager)

Get the app name (or more correctly the ID) that a collection is associated with, if possible. Here because I couldn't think of a better place for it. If you can, feel free to move it.