com.speedment.runtime.config.Schema Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of runtime-deploy Show documentation
Show all versions of runtime-deploy Show documentation
A Speedment bundle that shades all dependencies into one jar. This is
useful when deploying an application on a server.
/**
*
* 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.SchemaImpl;
import com.speedment.runtime.config.mutator.DocumentMutator;
import com.speedment.runtime.config.mutator.SchemaMutator;
import com.speedment.runtime.config.trait.HasAlias;
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 a schema instance in the database. A
* {@code Schema} is located inside a {@link Dbms} and can have multiple
* {@link Table Tables} as children.
*
* @author Emil Forslund
*/
public interface Schema extends
Document,
HasParent,
HasDeepCopy,
HasEnabled,
HasId,
HasName,
HasChildren,
HasAlias,
HasMainInterface,
HasMutator> {
String DEFAULT_SCHEMA = "defaultSchema",
TABLES = "tables";
/**
* Returns {@code true} if this schema is the default one, else
* {@code false}. Default value is {@code true}.
*
* @return {@code true} if default, else {@code false}
*/
default boolean isDefaultSchema() {
return getAsBoolean(DEFAULT_SCHEMA).orElse(true);
}
/**
* Creates a stream of tables located in this document.
*
* @return tables
*/
Stream tables();
//
// default Stream tables() {
// return children(TABLES, tableConstructor());
// }
//
// default Table addNewTable() {
// return tableConstructor().apply(this, newDocument(this, TABLES));
// }
//
// BiFunction, ? extends Table> tableConstructor();
@Override
default Class mainInterface() {
return Schema.class;
}
@Override
default SchemaMutator mutator() {
return DocumentMutator.of(this);
}
@Override
default Schema deepCopy() {
return DocumentUtil.deepCopy(this, SchemaImpl::new);
}
}