Package org.opends.guitools.controlpanel.datamodel

Class VLVIndexDescriptor

java.lang.Object

org.opends.guitools.controlpanel.datamodel.AbstractIndexDescriptor

org.opends.guitools.controlpanel.datamodel.VLVIndexDescriptor

All Implemented Interfaces:

Comparable<AbstractIndexDescriptor>

public class VLVIndexDescriptor
extends AbstractIndexDescriptor

The class used to describe the VLV index configuration.

Constructor Summary

Constructors

Constructor	Description
VLVIndexDescriptor(String name, BackendDescriptor backend, DN baseDN, SearchScope scope, String filter, List<VLVSortOrder> sortOrder)	Constructor for the VLVIndexDescriptor.

Method Summary

Modifier and Type	Method	Description
int	compareTo(AbstractIndexDescriptor o)
boolean	equals(Object o)
static BackendVLVIndexCfgDefn.Scope	getBackendVLVIndexScope(SearchScope scope)	Returns the equivalent BackendVLVIndexCfgDefn.Scope to the provided search scope.
DN	getBaseDN()	Returns the baseDN of the search indexed by the VLV index.
String	getFilter()	Returns the filter of the search indexed by the VLV index.
SearchScope	getScope()	Returns the scope of the search indexed by the VLV index.
List<VLVSortOrder>	getSortOrder()	Returns the sort order list of the VLV index.
int	hashCode()
protected void	recalculateHashCode()	Method used to minimize the times the hashcode is calculated.
static SearchScope	toSearchScope(BackendVLVIndexCfgDefn.Scope scope)	Convert the provided BackendVLVIndexCfgDefn.Scope to SearchScope.

Methods inherited from class org.opends.guitools.controlpanel.datamodel.AbstractIndexDescriptor

getBackend, getName, setBackend

Methods inherited from class java.lang.Object

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

Constructor Detail

VLVIndexDescriptor

public VLVIndexDescriptor(String name,
                          BackendDescriptor backend,
                          DN baseDN,
                          SearchScope scope,
                          String filter,
                          List<VLVSortOrder> sortOrder)

Constructor for the VLVIndexDescriptor.

Parameters:

name - the name of the index.

backend - the backend where the index is defined.

baseDN - the baseDN of the search indexed by the VLV index.

scope - the scope of the search indexed by the VLV index.

filter - the filter or the search indexed by the VLV index.

sortOrder - the sort order list of the VLV index.

Method Detail

compareTo

public int compareTo(AbstractIndexDescriptor o)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getBaseDN

public DN getBaseDN()

Returns the baseDN of the search indexed by the VLV index.

Returns:

the baseDN of the search indexed by the VLV index.

getFilter

public String getFilter()

Returns the filter of the search indexed by the VLV index.

Returns:

the filter of the search indexed by the VLV index.

getScope

public SearchScope getScope()

Returns the scope of the search indexed by the VLV index.

Returns:

the scope of the search indexed by the VLV index.

getSortOrder

public List<VLVSortOrder> getSortOrder()

Returns the sort order list of the VLV index.

Returns:

the sort order list of the VLV index.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

recalculateHashCode

protected void recalculateHashCode()

Description copied from class: AbstractIndexDescriptor

Method used to minimize the times the hashcode is calculated.

Specified by:

recalculateHashCode in class AbstractIndexDescriptor

getBackendVLVIndexScope

public static BackendVLVIndexCfgDefn.Scope getBackendVLVIndexScope(SearchScope scope)

Returns the equivalent BackendVLVIndexCfgDefn.Scope to the provided search scope.

Parameters:

scope - The SearchScope to convert.

Returns:

the equivalent BackendVLVIndexCfgDefn.Scope to the provided search scope.

toSearchScope

public static SearchScope toSearchScope(BackendVLVIndexCfgDefn.Scope scope)

Convert the provided BackendVLVIndexCfgDefn.Scope to SearchScope.

Parameters:

scope - The scope to convert.

Returns:

the provided BackendVLVIndexCfgDefn.Scope to SearchScope