GroupDocIdString (document 7.83.27 API)

java.lang.Object
- com.yahoo.document.idstring.IdString
- - com.yahoo.document.idstring.GroupDocIdString

```
public class GroupDocIdString
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
`GroupDocIdString(java.lang.String namespace, java.lang.String group, java.lang.String namespaceSpecific)`	Create a groupdoc scheme object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getGroup()`
`long`	`getLocation()`	Get the location of this document id.
`java.lang.String`	`getSchemeSpecific()`	Get the scheme specific part.
`boolean`	`hasGroup()`

Methods inherited from class com.yahoo.document.idstring.IdString
createFromSerialized, createIdString, equals, generateOrderDocParams, getDocType, getGidModifier, getNamespace, getNamespaceSpecific, getNumber, getSchemeParameters, getType, hasDocType, hashCode, hasNumber, toString, toUtf8

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GroupDocIdString
```
public GroupDocIdString(java.lang.String namespace,
                        java.lang.String group,
                        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.
    
    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 groupdoc scheme, the location is a hash of the groupname.
    
    Specified by:
    
    getLocation in class IdString
    
    Returns:
    
    The 64 bit location.
  - getSchemeSpecific
```
public java.lang.String getSchemeSpecific()
```
    Get the scheme specific part. Which is for a groupdoc, is the groupdoc and a colon.
    
    Specified by:
    
    getSchemeSpecific 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.