Package com.yahoo.document.idstring

Class OrderDocIdString

java.lang.Object

com.yahoo.document.idstring.IdString

com.yahoo.document.idstring.OrderDocIdString

public class OrderDocIdString
extends IdString

Representation of groupdoc scheme in document IDs.

Author:

Håkon Humberset

Nested Class Summary

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

IdString.GidModifier, IdString.Scheme

Constructor Summary

Constructors

Constructor	Description
OrderDocIdString(java.lang.String namespace, java.lang.String group, int widthBits, int divisionBits, long ordering, java.lang.String namespaceSpecific)	Create a groupdoc scheme object.

Method Summary

Modifier and Type	Method	Description
int	getDivisionBits()
IdString.GidModifier	getGidModifier()
java.lang.String	getGroup()
long	getLocation()	Get the location of this document id.
long	getNumber()
long	getOrdering()
java.lang.String	getSchemeParameters()
java.lang.String	getSchemeSpecific()	Get the scheme specific part.
long	getUserId()
int	getWidthBits()
boolean	hasGroup()
boolean	hasNumber()

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

createFromSerialized, createIdString, equals, generateOrderDocParams, getDocType, getNamespace, getNamespaceSpecific, getType, hasDocType, hashCode, toString, toUtf8

Methods inherited from class java.lang.Object

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

Constructor Detail

OrderDocIdString

public OrderDocIdString(java.lang.String namespace,
                        java.lang.String group,
                        int widthBits,
                        int divisionBits,
                        long ordering,
                        java.lang.String namespaceSpecific)

Create a groupdoc scheme object. groupdoc:<namespace>:<group>:<namespaceSpecific>

Parameters:

namespace - The namespace of this document id.

group - The groupname of this groupdoc id.

widthBits - The number of bits used for the width of the data set

divisionBits - The number of bits used for the smalles partitioning of the data set

ordering - A value used to order documents of this type.

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 orderdoc scheme, the location is a hash of the groupname or just the number specified.

Specified by:

getLocation in class IdString

Returns:

The 64 bit location.

getSchemeParameters

public java.lang.String getSchemeParameters()

Overrides:

getSchemeParameters in class IdString

getSchemeSpecific

public java.lang.String getSchemeSpecific()

Get the scheme specific part.

Specified by:

getSchemeSpecific in class IdString

getGidModifier

public IdString.GidModifier getGidModifier()

Overrides:

getGidModifier in class IdString

hasGroup

public boolean hasGroup()

Overrides:

hasGroup in class IdString

getGroup

public java.lang.String getGroup()

Overrides:

getGroup in class IdString

Returns:

Get the groupname of this id.

hasNumber

public boolean hasNumber()

Overrides:

hasNumber in class IdString

getNumber

public long getNumber()

Overrides:

getNumber in class IdString

getUserId

public long getUserId()

getWidthBits

public int getWidthBits()

getDivisionBits

public int getDivisionBits()

getOrdering

public long getOrdering()