Index.java
/*
** Module : Index.java
** Abstract : Index representation for database schema storage and comparison.
**
** Copyright (c) 2022-2024, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------------Description---------------------------------------
** 001 BS 20221103 Created initial version.
** 002 OM 20240412 Added sort direction for index components.
*/
/*
** This program is free software: you can redistribute it and/or modify
** it under the terms of the GNU Affero General Public License as
** published by the Free Software Foundation, either version 3 of the
** License, or (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU Affero General Public License for more details.
**
** You may find a copy of the GNU Affero GPL version 3 at the following
** location: https://www.gnu.org/licenses/agpl-3.0.en.html
**
** Additional terms under GNU Affero GPL version 3 section 7:
**
** Under Section 7 of the GNU Affero GPL version 3, the following additional
** terms apply to the works covered under the License. These additional terms
** are non-permissive additional terms allowed under Section 7 of the GNU
** Affero GPL version 3 and may not be removed by you.
**
** 0. Attribution Requirement.
**
** You must preserve all legal notices or author attributions in the covered
** work or Appropriate Legal Notices displayed by works containing the covered
** work. You may not remove from the covered work any author or developer
** credit already included within the covered work.
**
** 1. No License To Use Trademarks.
**
** This license does not grant any license or rights to use the trademarks
** Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
** of Golden Code Development Corporation. You are not authorized to use the
** name Golden Code, FWD, or the names of any author or contributor, for
** publicity purposes without written authorization.
**
** 2. No Misrepresentation of Affiliation.
**
** You may not represent yourself as Golden Code Development Corporation or FWD.
**
** You may not represent yourself for publicity purposes as associated with
** Golden Code Development Corporation, FWD, or any author or contributor to
** the covered work, without written authorization.
**
** 3. No Misrepresentation of Source or Origin.
**
** You may not represent the covered work as solely your work. All modified
** versions of the covered work must be marked in a reasonable way to make it
** clear that the modified work is not originating from Golden Code Development
** Corporation or FWD. All modified versions must contain the notices of
** attribution required in this license.
*/
package com.goldencode.p2j.persist.orm.schema.element;
import com.goldencode.p2j.util.*;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
/**
* Index representation for database schema storage and comparison.
*/
public class Index extends Element
{
/**
* List of columns the index is attached to. The elements of this list are composed of the column name (as
* a {@code String} and a {@code Boolean} representing the sort direction ({@code true} is ASCENDING)).
*/
private final List<Tuple<String, Boolean>> columns = new ArrayList<>();
/**
* Is unique?
*/
private final boolean unique;
/**
* Is primary?
*
* This property is only mutable because the standard JDBC API does not provide information whether the
* index is primary. This information has to be loaded separately and updated later.
*/
private boolean primary;
/**
* Default constructor.
*
* @param name
* Most basic property of any element - its name.
* @param table
* Table containing the index (parent).
* @param unique
* Is unique?
* @param primary
* Is primary?
* @param comment
* Comment for the index.
*/
public Index(String name, Table table, boolean unique, boolean primary, String comment)
{
super(name, table, comment);
this.unique = unique;
this.primary = primary;
}
/**
* Second constructor, that allows to fill columns on creation.
*
* @param name
* Most basic property of any element - it's name.
* @param table
* Table containing the index (parent).
* @param cols
* List of columns the index is attached to. The elements of this list are composed of the column
* name (as a {@code String} and a {@code Boolean} representing the sort direction ({@code true}
* is ASCENDING)).
* @param unique
* Is unique?
* @param primary
* Is primary?
* @param comment
* Comment for the index.
*/
public Index(String name,
Table table,
Collection<Tuple<String, Boolean>> cols,
boolean unique,
boolean primary,
String comment)
{
super(name, table, comment);
columns.addAll(cols);
this.unique = unique;
this.primary = primary;
}
/**
* Getter for columns.
*
* @return List of columns the index is attached to. The elements of this list are composed of the column
* name (as a {@code String} and a {@code Boolean} representing the sort direction ({@code true}
* is ASCENDING)).
*/
public List<Tuple<String, Boolean>> getColumns()
{
return columns;
}
/**
* Getter for unique.
*
* @return Is unique?
*/
public boolean getUnique()
{
return unique;
}
/**
* Getter for primary.
*
* @return Is primary?
*/
public boolean getPrimary()
{
return primary;
}
/**
* Setter for primary.
*
* @param isPrimary
* Is primary?
*/
public void setPrimary(boolean isPrimary)
{
primary = isPrimary;
}
}