Class DimensionalRoutedAlias
- java.lang.Object
-
- org.apache.solr.cloud.api.collections.RoutedAlias
-
- org.apache.solr.cloud.api.collections.DimensionalRoutedAlias
-
public class DimensionalRoutedAlias extends RoutedAlias
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.solr.cloud.api.collections.RoutedAlias
RoutedAlias.Action
-
-
Field Summary
-
Fields inherited from class org.apache.solr.cloud.api.collections.RoutedAlias
CATEGORY, CREATE_COLLECTION_PREFIX, DIMENSIONAL, MINIMAL_REQUIRED_PARAMS, ROUTED_ALIAS_NAME_CORE_PROP, ROUTER_FIELD, ROUTER_TYPE_NAME, TIME
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected List<RoutedAlias.Action>
calculateActions(String targetCol)
Determine the combination of adds/deletes implied by the arrival of a document destined for the specified collection.String
computeInitialCollectionName()
org.apache.solr.cloud.api.collections.RoutedAlias.CandidateCollection
findCandidateGivenValue(AddUpdateCommand cmd)
Map<String,String>
getAliasMetadata()
String
getAliasName()
The name of the alias.protected String
getHeadCollectionIfOrdered(AddUpdateCommand cmd)
Calculate the head collection (i.e.Set<String>
getOptionalParams()
Set<String>
getRequiredParams()
org.apache.solr.client.solrj.RoutedAliasTypes
getRoutedAliasType()
String
getRouteField()
boolean
updateParsedCollectionAliases(org.apache.solr.common.cloud.ZkStateReader zkStateReader, boolean contextualize)
Ensure our parsed version of the alias collection list is up to date.void
validateRouteValue(AddUpdateCommand cmd)
Check that the value we will be routing on is legal for this type of routed alias.-
Methods inherited from class org.apache.solr.cloud.api.collections.RoutedAlias
createCollectionsIfRequired, fromProps, newAliasMustExistException
-
-
-
-
Method Detail
-
updateParsedCollectionAliases
public boolean updateParsedCollectionAliases(org.apache.solr.common.cloud.ZkStateReader zkStateReader, boolean contextualize)
Description copied from class:RoutedAlias
Ensure our parsed version of the alias collection list is up to date. If it was modified, return true. Note that this will return true if some other alias was modified or if properties were modified. These are spurious and the caller should be written to be tolerant of no material changes.- Specified by:
updateParsedCollectionAliases
in classRoutedAlias
-
computeInitialCollectionName
public String computeInitialCollectionName()
-
getAliasName
public String getAliasName()
Description copied from class:RoutedAlias
The name of the alias. This name is used in place of a collection name for both queries and updates.- Specified by:
getAliasName
in classRoutedAlias
- Returns:
- The name of the Alias.
-
getRouteField
public String getRouteField()
-
getRoutedAliasType
public org.apache.solr.client.solrj.RoutedAliasTypes getRoutedAliasType()
-
validateRouteValue
public void validateRouteValue(AddUpdateCommand cmd) throws org.apache.solr.common.SolrException
Description copied from class:RoutedAlias
Check that the value we will be routing on is legal for this type of routed alias.- Specified by:
validateRouteValue
in classRoutedAlias
- Parameters:
cmd
- the command containing the document- Throws:
org.apache.solr.common.SolrException
-
getRequiredParams
public Set<String> getRequiredParams()
- Specified by:
getRequiredParams
in classRoutedAlias
-
getOptionalParams
public Set<String> getOptionalParams()
- Specified by:
getOptionalParams
in classRoutedAlias
-
findCandidateGivenValue
public org.apache.solr.cloud.api.collections.RoutedAlias.CandidateCollection findCandidateGivenValue(AddUpdateCommand cmd)
-
getHeadCollectionIfOrdered
protected String getHeadCollectionIfOrdered(AddUpdateCommand cmd)
Description copied from class:RoutedAlias
Calculate the head collection (i.e. the most recent one for a TRA) if this routed alias has an implicit order, or if the collection is unordered return the appropriate collection name for the value in the current document. This method should never return null.- Specified by:
getHeadCollectionIfOrdered
in classRoutedAlias
-
calculateActions
protected List<RoutedAlias.Action> calculateActions(String targetCol)
Determine the combination of adds/deletes implied by the arrival of a document destined for the specified collection.- Specified by:
calculateActions
in classRoutedAlias
- Parameters:
targetCol
- the collection for which a document is destined.- Returns:
- A list of actions across the DRA.
-
-