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