DocCollection (Lindorm Search Client 8.10.2 API)

java.lang.Object
- org.apache.solr.common.cloud.ZkNodeProps
- - org.apache.solr.common.cloud.DocCollection

所有已实现的接口:

Iterable<Slice>, JSONWriter.Writable
```
public class DocCollection
extends ZkNodeProps
implements Iterable<Slice>
```
Models a Collection in zookeeper (but that Java name is obviously taken, hence "DocCollection")

字段概要

字段
限定符和类型	字段和说明
`static String`	`DOC_ROUTER`
`static String`	`PARTITIONS`
`static String`	`PER_REPLICA_STATE`
`static String`	`ROUTER_FIELD`
`static String`	`ROUTER_NAME`
`static String`	`ROUTER_PARTITIONS`
`static String`	`RULE` 已过时。 to be removed in Solr 9.0 (see SOLR-14930)
`static String`	`SHARDS`
`static String`	`SNITCH` 已过时。 to be removed in Solr 9.0 (see SOLR-14930)
`static String`	`STATE_FORMAT`

从类继承的字段 org.apache.solr.common.cloud.ZkNodeProps
propMap, STORE_BASE_URL

构造器概要

构造器
构造器和说明
`DocCollection(String name, Map<String,Slice> slices, Map<String,Object> props, DocRouter router)`
`DocCollection(String name, Map<String,Slice> slices, Map<String,Object> props, DocRouter router, int zkVersion, String znode)`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`DocCollection`	`copyWith(PerReplicaStates newPerReplicaStates)` Update our state with a state of a `Replica` Used to create a new Collection State when only a replica is updated
`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
`boolean`	`equals(Object that)`
`void`	`forEachReplica(BiConsumer<String,Replica> consumer)`
`Collection<Slice>`	`getActiveSlices()` Return the list of active slices for this collection.
`Slice[]`	`getActiveSlicesArr()` Return array of active slices for this collection (performance optimization).
`Map<String,Slice>`	`getActiveSlicesMap()` Get the map of active slices (sliceName->Slice) for this collection.
`boolean`	`getAutoAddReplicas()`
`int`	`getChildNodesVersion()`
`int`	`getExpectedReplicaCount(Replica.Type type, int def)`
`Replica`	`getLeader(String sliceName)`
`List<Replica>`	`getLeaderReplicas(String nodeName)` Get the list of all leaders hosted on the given node or `null` if none.
`int`	`getMaxShardsPerNode()`
`String`	`getName()` Return collection name.
`Integer`	`getNumNrtReplicas()`
`Integer`	`getNumPullReplicas()`
`Integer`	`getNumTlogReplicas()`
`PerReplicaStates`	`getPerReplicaStates()`
`String`	`getPolicyName()`
`Replica`	`getReplica(BiPredicate<String,Replica> predicate)`
`Replica`	`getReplica(String coreNodeName)`
`List<Replica>`	`getReplicas()`
`List<Replica>`	`getReplicas(EnumSet<Replica.Type> s)`
`List<Replica>`	`getReplicas(String nodeName)` Get the list of replicas hosted on the given node or `null` if none.
`Integer`	`getReplicationFactor()`
`DocRouter`	`getRouter()`
`String`	`getShardId(String nodeName, String coreName)` Get the shardId of a core on a specific node
`Slice`	`getSlice(String sliceName)`
`Collection<Slice>`	`getSlices()` Gets the list of all slices for this collection.
`Map<String,Slice>`	`getSlicesMap()` Get the map of all slices (sliceName->Slice) for this collection.
`int`	`getStateFormat()`
`String`	`getStoragePolicy()`
`Integer`	`getTTL()`
`String`	`getUniqueKey()`
`Map<String,List<String>>`	`getUrlMap()`
`String`	`getZNode()`
`int`	`getZNodeVersion()`
`int`	`hashCode()`
`static boolean`	`isFullyActive(Set<String> liveNodes, DocCollection collectionState, int expectedShards, int expectedReplicas)` Check that all replicas in a collection are live
`boolean`	`isModified(int dataVersion, int childVersion)`
`boolean`	`isPerReplicaState()`
`boolean`	`isReadOnly()`
`Iterator<Slice>`	`iterator()`
`void`	`setUrlMap(Map<String,List<String>> urlMap)`
`String`	`toString()`
`static Object`	`verifyProp(Map<String,Object> props, String propName)`
`static Object`	`verifyProp(Map<String,Object> props, String propName, Object def)`
`void`	`write(JSONWriter jsonWriter)`

从类继承的方法 org.apache.solr.common.cloud.ZkNodeProps
containsKey, fromKeyVals, get, getBool, getInt, getProperties, getStr, getStr, keySet, load, plus, plus, shallowCopy

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

从接口继承的方法 java.lang.Iterable
forEach, spliterator

字段详细资料
- DOC_ROUTER
```
public static final String DOC_ROUTER
```
  另请参阅:
  
  常量字段值
- PARTITIONS
```
public static final String PARTITIONS
```
  另请参阅:
  
  常量字段值
- ROUTER_NAME
```
public static final String ROUTER_NAME
```
  另请参阅:
  
  常量字段值
- ROUTER_PARTITIONS
```
public static final String ROUTER_PARTITIONS
```
  另请参阅:
  
  常量字段值
- ROUTER_FIELD
```
public static final String ROUTER_FIELD
```
  另请参阅:
  
  常量字段值
- SHARDS
```
public static final String SHARDS
```
  另请参阅:
  
  常量字段值
- PER_REPLICA_STATE
```
public static final String PER_REPLICA_STATE
```
  另请参阅:
  
  常量字段值
- STATE_FORMAT
```
public static final String STATE_FORMAT
```
  另请参阅:
  
  常量字段值
- RULE
```
public static final String RULE
```
  已过时。 to be removed in Solr 9.0 (see SOLR-14930)
  
  另请参阅:
  
  常量字段值
- SNITCH
```
public static final String SNITCH
```
  已过时。 to be removed in Solr 9.0 (see SOLR-14930)
  
  另请参阅:
  
  常量字段值

构造器详细资料

DocCollection

public DocCollection(String name,
                     Map<String,Slice> slices,
                     Map<String,Object> props,
                     DocRouter router)

DocCollection

public DocCollection(String name,
                     Map<String,Slice> slices,
                     Map<String,Object> props,
                     DocRouter router,
                     int zkVersion,
                     String znode)

参数:: name - The name of the collection; slices - The logical shards of the collection. This is used directly and a copy is not made.; props - The properties of the slice. This is used directly and a copy is not made.

方法详细资料

copyWith
```
public DocCollection copyWith(PerReplicaStates newPerReplicaStates)
```
Update our state with a state of a Replica Used to create a new Collection State when only a replica is updated

verifyProp

public static Object verifyProp(Map<String,Object> props,
                                String propName)

verifyProp

public static Object verifyProp(Map<String,Object> props,
                                String propName,
                                Object def)

copyWithSlices
```
public 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

参数:

slices - the new set of Slices

返回:

the resulting DocCollection

getName
```
public String getName()
```
Return collection name.

getSlice

public Slice getSlice(String sliceName)

forEachReplica

public void forEachReplica(BiConsumer<String,Replica> consumer)

参数:: consumer - consume shardName vs. replica

getSlices
```
public Collection<Slice> getSlices()
```
Gets the list of all slices for this collection.

getActiveSlices
```
public Collection<Slice> getActiveSlices()
```
Return the list of active slices for this collection.

getActiveSlicesArr
```
public Slice[] getActiveSlicesArr()
```
Return array of active slices for this collection (performance optimization).

getSlicesMap
```
public Map<String,Slice> getSlicesMap()
```
Get the map of all slices (sliceName->Slice) for this collection.

getActiveSlicesMap
```
public Map<String,Slice> getActiveSlicesMap()
```
Get the map of active slices (sliceName->Slice) for this collection.

getReplicas
```
public List<Replica> getReplicas(String nodeName)
```
Get the list of replicas hosted on the given node or null if none.

getLeaderReplicas
```
public List<Replica> getLeaderReplicas(String nodeName)
```
Get the list of all leaders hosted on the given node or null if none.

getZNodeVersion
```
public int getZNodeVersion()
```

getChildNodesVersion
```
public int getChildNodesVersion()
```

isModified

public boolean isModified(int dataVersion,
                          int childVersion)

getStateFormat
```
public int getStateFormat()
```

getReplicationFactor
```
public Integer getReplicationFactor()
```
返回:

replication factor for this collection or null if no replication factor exists.

getAutoAddReplicas
```
public boolean getAutoAddReplicas()
```

getMaxShardsPerNode
```
public int getMaxShardsPerNode()
```

getZNode
```
public String getZNode()
```

getRouter
```
public DocRouter getRouter()
```

isReadOnly
```
public boolean isReadOnly()
```

getTTL
```
public Integer getTTL()
```

getUniqueKey
```
public String getUniqueKey()
```

getStoragePolicy
```
public String getStoragePolicy()
```

toString
```
public String toString()
```
覆盖:

toString 在类中 ZkNodeProps

write
```
public void write(JSONWriter jsonWriter)
```
指定者:

write 在接口中 JSONWriter.Writable

覆盖:

write 在类中 ZkNodeProps

getReplica

public Replica getReplica(String coreNodeName)

getLeader

public Replica getLeader(String sliceName)

isFullyActive

public static boolean isFullyActive(Set<String> liveNodes,
                                    DocCollection collectionState,
                                    int expectedShards,
                                    int expectedReplicas)

Check that all replicas in a collection are live

另请参阅:: CollectionStatePredicate

iterator
```
public Iterator<Slice> iterator()
```
指定者:

iterator 在接口中 Iterable<Slice>

getReplicas
```
public List<Replica> getReplicas()
```

getReplica
```
public Replica getReplica(BiPredicate<String,Replica> predicate)
```
参数:

predicate - test against shardName vs. replica

返回:

the first replica that matches the predicate

getReplicas

public List<Replica> getReplicas(EnumSet<Replica.Type> s)

getShardId

public String getShardId(String nodeName,
                         String coreName)

Get the shardId of a core on a specific node

equals
```
public boolean equals(Object that)
```
覆盖:

equals 在类中 ZkNodeProps

hashCode
```
public int hashCode()
```
覆盖:

hashCode 在类中 ZkNodeProps

getNumNrtReplicas
```
public Integer getNumNrtReplicas()
```
返回:

the number of replicas of type Replica.Type.NRT this collection was created with

getNumTlogReplicas
```
public Integer getNumTlogReplicas()
```
返回:

the number of replicas of type Replica.Type.TLOG this collection was created with

getNumPullReplicas
```
public Integer getNumPullReplicas()
```
返回:

the number of replicas of type Replica.Type.PULL this collection was created with

getPolicyName
```
public String getPolicyName()
```
返回:

the policy associated with this collection if any

isPerReplicaState
```
public boolean isPerReplicaState()
```

getPerReplicaStates

public PerReplicaStates getPerReplicaStates()

getExpectedReplicaCount

public int getExpectedReplicaCount(Replica.Type type,
                                   int def)

getUrlMap

public Map<String,List<String>> getUrlMap()

setUrlMap

public void setUrlMap(Map<String,List<String>> urlMap)

类 DocCollection

字段概要

从类继承的字段 org.apache.solr.common.cloud.ZkNodeProps

构造器概要

方法概要

从类继承的方法 org.apache.solr.common.cloud.ZkNodeProps

从类继承的方法 java.lang.Object

从接口继承的方法 java.lang.Iterable

字段详细资料

DOC_ROUTER

PARTITIONS

ROUTER_NAME

ROUTER_PARTITIONS

ROUTER_FIELD

SHARDS

PER_REPLICA_STATE

STATE_FORMAT

RULE

SNITCH

构造器详细资料

DocCollection

DocCollection

方法详细资料

copyWith

verifyProp

verifyProp

copyWithSlices

getName

getSlice

forEachReplica

getSlices

getActiveSlices

getActiveSlicesArr

getSlicesMap

getActiveSlicesMap

getReplicas

getLeaderReplicas

getZNodeVersion

getChildNodesVersion

isModified

getStateFormat

getReplicationFactor

getAutoAddReplicas

getMaxShardsPerNode

getZNode

getRouter

isReadOnly

getTTL

getUniqueKey

getStoragePolicy

toString

write

getReplica

getLeader

isFullyActive

iterator

getReplicas

getReplica

getReplicas

getShardId

equals

hashCode

getNumNrtReplicas

getNumTlogReplicas

getNumPullReplicas

getPolicyName

isPerReplicaState

getPerReplicaStates

getExpectedReplicaCount

getUrlMap

setUrlMap