org.apache.directory.server.xdbm

Class ParentIdAndRdn

java.lang.Object

org.apache.directory.server.xdbm.ParentIdAndRdn

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Comparable<ParentIdAndRdn>

public class ParentIdAndRdn
extends java.lang.Object
implements java.io.Externalizable, java.lang.Comparable<ParentIdAndRdn>

A wrapper for the tuple of parentId and Rdn, used for the Rdn index. If the refered entry is a ContextEntry, we may have more than one Rdn stored

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	nbChildren Number of direct children
protected int	nbDescendants Number of global descendant
protected java.lang.String	parentId The entry ID
protected org.apache.directory.api.ldap.model.name.Rdn[]	rdns The list of Rdn for this instance

Constructor Summary

Constructors

Constructor and Description
ParentIdAndRdn() Serializable constructor.
ParentIdAndRdn(java.lang.String parentId, java.util.List<org.apache.directory.api.ldap.model.name.Rdn> rdns) Creates a new instance of ParentIdAndRdn.
ParentIdAndRdn(java.lang.String parentId, org.apache.directory.api.ldap.model.name.Rdn... rdns) Creates a new instance of ParentIdAndRdn.

Method Summary

Modifier and Type	Method and Description
int	compareTo(ParentIdAndRdn that)
boolean	equals(java.lang.Object obj)
int	getNbChildren()
int	getNbDescendants()
java.lang.String	getParentId() Gets the parent ID.
org.apache.directory.api.ldap.model.name.Rdn[]	getRdns() Gets the RDNs.
int	hashCode()
void	readExternal(java.io.ObjectInput in)
void	setNbChildren(int nbChildren) Sets the number of children this entry has
void	setNbDescendants(int nbDescendants) Sets the number of descendants this entry has
void	setParentId(java.lang.String parentId) Sets the parent ID.
void	setRdns(org.apache.directory.api.ldap.model.name.Rdn... rdns) Sets the Rdn.
java.lang.String	toString()
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

parentId

protected java.lang.String parentId

The entry ID

rdns

protected org.apache.directory.api.ldap.model.name.Rdn[] rdns

The list of Rdn for this instance

nbChildren

protected int nbChildren

Number of direct children

nbDescendants

protected int nbDescendants

Number of global descendant

Constructor Detail

ParentIdAndRdn

public ParentIdAndRdn()

Serializable constructor.

ParentIdAndRdn

public ParentIdAndRdn(java.lang.String parentId,
                      org.apache.directory.api.ldap.model.name.Rdn... rdns)

Creates a new instance of ParentIdAndRdn.

Parameters:

parentId - the parent ID

rdns - the RDNs

ParentIdAndRdn

public ParentIdAndRdn(java.lang.String parentId,
                      java.util.List<org.apache.directory.api.ldap.model.name.Rdn> rdns)

Creates a new instance of ParentIdAndRdn.

Parameters:

parentId - the parent ID

rdns - the RDNs

Method Detail

getParentId

public java.lang.String getParentId()

Gets the parent ID.

Returns:

the parent ID

setParentId

public void setParentId(java.lang.String parentId)

Sets the parent ID.

Parameters:

parentId - the new parent ID

getRdns

public org.apache.directory.api.ldap.model.name.Rdn[] getRdns()

Gets the RDNs.

Returns:

the RDNs

setRdns

public void setRdns(org.apache.directory.api.ldap.model.name.Rdn... rdns)

Sets the Rdn.

Parameters:

rdns - the new Rdn

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(ParentIdAndRdn that)

Specified by:

compareTo in interface java.lang.Comparable<ParentIdAndRdn>

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException

getNbChildren

public int getNbChildren()

Returns:

The number of children this entry has

setNbChildren

public void setNbChildren(int nbChildren)

Sets the number of children this entry has

Parameters:

nbChildren - The number of children

getNbDescendants

public int getNbDescendants()

Returns:

The number of descendants this entry has

setNbDescendants

public void setNbDescendants(int nbDescendants)

Sets the number of descendants this entry has

Parameters:

nbChildren - The number of descendants

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object