001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2008-2010 Sun Microsystems, Inc.
025 */
026
027package org.opends.guitools.controlpanel.datamodel;
028
029/**
030 * Abstract class used to describe the configuration of an index.
031 *
032 */
033public abstract class AbstractIndexDescriptor
034implements Comparable<AbstractIndexDescriptor>
035{
036  private String name;
037  private BackendDescriptor backend;
038  /**
039   * Constructor.
040   * @param name the name of the index.
041   * @param backend the backend where the index is defined.
042   */
043  protected AbstractIndexDescriptor(String name, BackendDescriptor backend)
044  {
045    this.name = name;
046    this.backend = backend;
047  }
048
049  /**
050   * Returns the name of the index.
051   * @return the name of the index.
052   */
053  public String getName()
054  {
055    return name;
056  }
057
058  /**
059   * Returns the backend where the index is defined.
060   * @return the backend where the index is defined.
061   */
062  public BackendDescriptor getBackend()
063  {
064    return backend;
065  }
066
067  /**
068   * Sets which is the backend where the index is defined.
069   * @param backend the backend where the index is defined.
070   */
071  public void setBackend(BackendDescriptor backend)
072  {
073    this.backend = backend;
074    recalculateHashCode();
075  }
076
077  /**
078   * Method used to minimize the times the hashcode is calculated.
079   *
080   */
081  protected abstract void recalculateHashCode();
082}