com.adobe.cq.social.storage.buckets

Interface NestedBucketStorageSystem

public interface NestedBucketStorageSystem

The NestedBucketStorageSystem is a facility which manages JCR node creation under a single root node. Nodes are organized in buckets of 1000 nodes. The client can specify the bucket postfix string and the bucket resource type. The default bucket postfix string is "Bucket", and "sling:Folder" is the bucket resource type. An instance of the NestedBucketStorageSystem should be obtain using the sling adatpTo mechanism: NestedBucketStorageSystem nestedBucketStorageSystem = root.adaptTo(NestedBucketStorageSystem.class);

Field Summary

Fields

Modifier and Type	Field and Description
static String	BUCKET_TYPE The default bucket type.
static String	DEFAULT_BUCKET_POSTFIX The default bucket postfix.
static int	MAX_NODES_PER_BUCKET The maximum number of nodes per bucket.

Method Summary

Methods

Modifier and Type	Method and Description
Node	addNode(String name, String primaryNodeTypeName) Add a new node with the given name and primary node type name.
Resource	addResource(String name, String primaryNodeTypeName) Add a new resource with the given name and primary node type name.
String	getBucketPostfix() Get the bucket postfix.
String	getBucketResourceType() Get the bucket type.
long	getNumberChildren() Returns the number of resource located under the root node.
Resource	getRoot() Returns the root node of the storage system, for example, /content/usergenerated/content/geometrixx/en/community/jcr:content/forum node.
Iterator<Resource>	listBuckets() List the buckets.
Iterator<Resource>	listChildren() Returns an iterator of the children of this bucket storage system.
void	setBucketPostfix(String postfix) Set the bucket postfix.
void	setBucketResourceType(String type) Set the bucket type.

Field Detail

MAX_NODES_PER_BUCKET

static final int MAX_NODES_PER_BUCKET

The maximum number of nodes per bucket.

See Also:

Constant Field Values

BUCKET_TYPE

static final String BUCKET_TYPE

The default bucket type.

See Also:

Constant Field Values

DEFAULT_BUCKET_POSTFIX

static final String DEFAULT_BUCKET_POSTFIX

The default bucket postfix.

See Also:

Constant Field Values

Method Detail

getRoot

Resource getRoot()

Returns the root node of the storage system, for example, /content/usergenerated/content/geometrixx/en/community/jcr:content/forum node.

Returns:

The root node

setBucketPostfix

void setBucketPostfix(String postfix)

Set the bucket postfix.

getBucketPostfix

String getBucketPostfix()

Get the bucket postfix.

setBucketResourceType

void setBucketResourceType(String type)

Set the bucket type.

getBucketResourceType

String getBucketResourceType()

Get the bucket type.

getNumberChildren

long getNumberChildren()
                       throws NestedBucketStorageException

Returns the number of resource located under the root node.

Throws:

NestedBucketStorageException

listChildren

Iterator<Resource> listChildren()
                                throws NestedBucketStorageException

Returns an iterator of the children of this bucket storage system.

Returns:

The comments

Throws:

NestedBucketStorageException

addResource

Resource addResource(String name,
                   String primaryNodeTypeName)
                     throws NestedBucketStorageException

Add a new resource with the given name and primary node type name.

Parameters:

name - - name of the resource to add

primaryNodeTypeName - - primary node type of the node to add

Returns:

Resource The new resource

Throws:

NestedBucketStorageException

addNode

Node addNode(String name,
           String primaryNodeTypeName)
             throws NestedBucketStorageException

Add a new node with the given name and primary node type name.

Parameters:

name - - name of the resource to add

primaryNodeTypeName - - primary node type of the node to add

Returns:

Node the new node

Throws:

NestedBucketStorageException

listBuckets

Iterator<Resource> listBuckets()
                               throws NestedBucketStorageException

List the buckets.

Returns:

Iterator

Throws:

NestedBucketStorageException