## Uses of Class
org.apache.solr.common.cloud.DocCollection

- Packages that use DocCollection
  Package | Description
  --- | ---
  org.apache.solr.client.solrj.impl | Concrete implementations of client API classes.
  org.apache.solr.client.solrj.request | Convenience classes for dealing with various types of Solr requests.
  org.apache.solr.common.cloud | Common Solr Cloud and ZooKeeper related classes reused on both clients & server.

- - ### Uses of DocCollection in org.apache.solr.client.solrj.impl

    Methods in org.apache.solr.client.solrj.impl that return DocCollection
    Modifier and Type | Method and Description
    --- | ---
    `protected DocCollection` | CloudSolrClient.`getDocCollection(ClusterState clusterState, String collection, Integer expectedVersion)`

  - ### Uses of DocCollection in org.apache.solr.client.solrj.request

    Methods in org.apache.solr.client.solrj.request with parameters of type DocCollection
    Modifier and Type | Method and Description
    --- | ---
    `Map<String,LBHttpSolrClient.Req>` | UpdateRequest.`getRoutes(DocRouter router, DocCollection col, Map<String,List<String>> urlMap, ModifiableSolrParams params, String idField)`

  - ### Uses of DocCollection in org.apache.solr.common.cloud

    Methods in org.apache.solr.common.cloud that return DocCollection
    Modifier and Type | Method and Description
    --- | ---
    `DocCollection` | DocCollection.`copyWithSlices(Map<String,Slice> slices)` Use this to make an exact copy of DocCollection with a new set of Slices and every other property as is
    `DocCollection` | ClusterState.CollectionRef.`get()`
    `DocCollection` | ClusterState.`getCollection(String collection)` Get the named DocCollection object, or throw an exception if it doesn't exist.
    `static DocCollection` | ZkStateReader.`getCollectionLive(ZkStateReader zkStateReader, String coll)`
    `DocCollection` | ClusterState.`getCollectionOrNull(String collectionName)` Returns the corresponding `DocCollection` object for the given collection name if such a collection exists.

    Methods in org.apache.solr.common.cloud that return types with arguments of type DocCollection
    Modifier and Type | Method and Description
    --- | ---
    `Map<String,DocCollection>` | ClusterState.`getCollectionsMap()` Get a map of collection name vs DocCollection objects Implementation note: This method resolves the collection reference by calling `ClusterState.CollectionRef.get()` which can make a call to ZooKeeper.

    Methods in org.apache.solr.common.cloud with parameters of type DocCollection
    Modifier and Type | Method and Description
    --- | ---
    `ClusterState` | ClusterState.`copyWith(String collectionName, DocCollection collection)` Returns a new cluster state object modified with the given collection.
    `protected String` | DocRouter.`getRouteField(DocCollection coll)`
    `Collection<Slice>` | DocRouter.`getSearchSlices(String shardKeys, SolrParams params, DocCollection collection)` This method is consulted to determine what slices should be queried for a request when an explicit shards parameter was not used.
    `Collection<Slice>` | CompositeIdRouter.`getSearchSlicesSingle(String shardKey, SolrParams params, DocCollection collection)`
    `Collection<Slice>` | HashBasedRouter.`getSearchSlicesSingle(String shardKey, SolrParams params, DocCollection collection)`
    `abstract Collection<Slice>` | DocRouter.`getSearchSlicesSingle(String shardKey, SolrParams params, DocCollection collection)` This method is consulted to determine what slices should be queried for a request when an explicit shards parameter was not used.
    `Collection<Slice>` | ImplicitDocRouter.`getSearchSlicesSingle(String shardKey, SolrParams params, DocCollection collection)`
    `Slice` | HashBasedRouter.`getTargetSlice(String id, SolrInputDocument sdoc, String route, SolrParams params, DocCollection collection)`
    `abstract Slice` | DocRouter.`getTargetSlice(String id, SolrInputDocument sdoc, String route, SolrParams params, DocCollection collection)` Returns the Slice that the document should reside on, or null if there is not enough information
    `Slice` | ImplicitDocRouter.`getTargetSlice(String id, SolrInputDocument sdoc, String route, SolrParams params, DocCollection collection)`
    `protected Slice` | HashBasedRouter.`hashToSlice(int hash, DocCollection collection)`
    `static boolean` | DocCollection.`isFullyActive(Set<String> liveNodes, DocCollection collectionState, int expectedShards, int expectedReplicas)` Check that all replicas in a collection are live
    `boolean` | HashBasedRouter.`isTargetSlice(String id, SolrInputDocument sdoc, SolrParams params, String shardId, DocCollection collection)`
    `abstract boolean` | DocRouter.`isTargetSlice(String id, SolrInputDocument sdoc, SolrParams params, String shardId, DocCollection collection)`
    `boolean` | ImplicitDocRouter.`isTargetSlice(String id, SolrInputDocument sdoc, SolrParams params, String shardId, DocCollection collection)`
    `boolean` | CollectionStatePredicate.`matches(Set<String> liveNodes, DocCollection collectionState)` Check the collection state matches a required state Note that both liveNodes and collectionState should be consulted to determine the overall state.
    `boolean` | CollectionStateWatcher.`onStateChanged(Set<String> liveNodes, DocCollection collectionState)` Called when the collection we are registered against has a change of state Note that, due to the way Zookeeper watchers are implemented, a single call may be the result of several state changes
    `int` | CompositeIdRouter.`sliceHash(String id, SolrInputDocument doc, SolrParams params, DocCollection collection)`
    `int` | HashBasedRouter.`sliceHash(String id, SolrInputDocument sdoc, SolrParams params, DocCollection collection)`

    Constructors in org.apache.solr.common.cloud with parameters of type DocCollection
    Constructor and Description
    `CollectionRef(DocCollection coll)`

    Constructor parameters in org.apache.solr.common.cloud with type arguments of type DocCollection
    Constructor and Description
    `ClusterState(Integer znodeVersion, Set<String> liveNodes, Map<String,DocCollection> collectionStates)` Use this constr when ClusterState is meant for consumption.

Copyright © 2000-2016 Apache Software Foundation. All Rights Reserved.