Package com.yahoo.document.idstring

Class DocIdString

java.lang.Object

com.yahoo.document.idstring.IdString

com.yahoo.document.idstring.DocIdString

public class DocIdString
extends IdString

Representation of doc scheme in document IDs.

Author:

Einar M R Rosenvinge

Nested Class Summary

Nested classes/interfaces inherited from class com.yahoo.document.idstring.IdString

IdString.GidModifier, IdString.Scheme

Constructor Summary

Constructors

Constructor	Description
DocIdString(java.lang.String namespace, java.lang.String namespaceSpecific)	Create a doc scheme object.

Method Summary

Modifier and Type	Method	Description
long	getLocation()	Get the location of this document id.
java.lang.String	getSchemeSpecific()	Get the scheme specific part.

Methods inherited from class com.yahoo.document.idstring.IdString

createFromSerialized, createIdString, equals, generateOrderDocParams, getDocType, getGidModifier, getGroup, getNamespace, getNamespaceSpecific, getNumber, getSchemeParameters, getType, hasDocType, hasGroup, hashCode, hasNumber, toString, toUtf8

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DocIdString

public DocIdString(java.lang.String namespace,
                   java.lang.String namespaceSpecific)

Create a doc scheme object. doc:<namespace>:<namespaceSpecific>

Parameters:

namespace - The namespace of this document id.

namespaceSpecific - The namespace specific part.

Method Detail

getLocation

public long getLocation()

Get the location of this document id. The location is used for distribution in clusters. For the doc scheme, the location is a hash of the whole id.

Specified by:

getLocation in class IdString

Returns:

The 64 bit location.

getSchemeSpecific

public java.lang.String getSchemeSpecific()

Get the scheme specific part. Which is non-existing for doc scheme.

Specified by:

getSchemeSpecific in class IdString