org.jooq.meta.Definition Maven / Gradle / Ivy
/*
* 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
*
* https://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.
*
* Other licenses:
* -----------------------------------------------------------------------------
* Commercial licenses for this work are available. These replace the above
* Apache-2.0 license and offer limited warranties, support, maintenance, and
* commercial database integrations.
*
* For more information, please visit: https://www.jooq.org/legal/licensing
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*/
package org.jooq.meta;
import java.util.List;
import org.jooq.Name;
// ...
import org.jooq.meta.jaxb.CommentType;
import org.jooq.meta.jaxb.SyntheticObjectsType;
/**
* A general interface defining any database object, such as tables, views,
* stored procedures, etc.
*
* @author Lukas Eder
*/
public interface Definition {
/**
* @return A reference to the Database context
*/
Database getDatabase();
/**
* @return The catalog of this object.
*/
CatalogDefinition getCatalog();
/**
* @return The schema of this object or null
if this object is
* a {@link CatalogDefinition}.
*/
SchemaDefinition getSchema();
/**
* @return The package of this object or null
if this object is
* not contained in a package.
*/
PackageDefinition getPackage();
/**
* @return The name of this object, e.g. [my_table]. This corresponds to
* {@link #getInputName()}
*/
String getName();
/**
* @return The name of this object, e.g. [my_table], as defined in the
* source database.
*/
String getInputName();
/**
* @return The name of this object, e.g. [my_table], as defined for the
* target database. This may differ from the input name if schema /
* table rewriting is applied.
*/
String getOutputName();
/**
* @return The comment of this object
*/
String getComment();
/**
* @return A path of definitions for this definition, e.g.
* [schema].[package].[routine].[parameter]
*/
List getDefinitionPath();
/**
* @return A qualified name for this object (corresponding to
* {@link #getName()})
*/
String getQualifiedName();
/**
* @return A qualified name for this object (corresponding to
* {@link #getInputName()})
*/
String getQualifiedInputName();
/**
* @return A qualified name for this object (corresponding to
* {@link #getOutputName()})
*/
String getQualifiedOutputName();
/**
* @return A qualified name for this object (corresponding to
* {@link #getName()})
*/
Name getQualifiedNamePart();
/**
* @return A qualified name for this object (corresponding to
* {@link #getInputName()})
*/
Name getQualifiedInputNamePart();
/**
* @return A qualified name for this object (corresponding to
* {@link #getOutputName()})
*/
Name getQualifiedOutputNamePart();
/**
* @return The overload suffix if applicable
*/
String getOverload();
/**
* @return The source code of this object, if applicable, or
* null
, if no such source code is available.
*/
String getSource();
/**
* Whether the object has been created "synthetically", i.e. from
* {@link SyntheticObjectsType}, rather than from the underlying meta data
* source.
*/
default boolean isSynthetic() {
return false;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy