com.speedment.runtime.config.Index Maven / Gradle / Ivy
Show all versions of tool-deploy Show documentation
/*
*
* Copyright (c) 2006-2019, Speedment, Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"); You may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.speedment.runtime.config;
import com.speedment.runtime.config.internal.IndexImpl;
import com.speedment.runtime.config.mutator.DocumentMutator;
import com.speedment.runtime.config.mutator.IndexMutator;
import com.speedment.runtime.config.trait.HasChildren;
import com.speedment.runtime.config.trait.HasDeepCopy;
import com.speedment.runtime.config.trait.HasEnabled;
import com.speedment.runtime.config.trait.HasId;
import com.speedment.runtime.config.trait.HasMainInterface;
import com.speedment.runtime.config.trait.HasMutator;
import com.speedment.runtime.config.trait.HasName;
import com.speedment.runtime.config.trait.HasParent;
import com.speedment.runtime.config.util.DocumentUtil;
import java.util.stream.Stream;
/**
* A typed {@link Document} that represents an index instance in the database.
* An {@code Index} is located inside a {@link Table} and can have
* multiple {@link IndexColumn IndexColumns} as children.
*
* @author Emil Forslund
* @since 2.0.0
*/
public interface Index extends
Document,
HasParent,
HasDeepCopy,
HasEnabled,
HasId,
HasName,
HasChildren,
HasMainInterface,
HasMutator> {
/**
* Returns whether or not this index is an {@code UNIQUE} index.
*
* This property is editable in the GUI through reflection.
*
* @return {@code true} if this index is {@code UNIQUE}
*/
default boolean isUnique() {
return getAsBoolean(IndexUtil.UNIQUE).orElse(false);
}
/**
* Creates a stream of index columns located in this document.
*
* @return index columns
*/
Stream indexColumns();
@Override
default Class mainInterface() {
return Index.class;
}
@Override
default IndexMutator mutator() {
return DocumentMutator.of(this);
}
@Override
default Index deepCopy() {
return DocumentUtil.deepCopy(this, IndexImpl::new);
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy