Top Description Methods
org.hibernate.tool.schema.spi

public Interface SourceDescriptor

Known Direct Subinterfaces
org.hibernate.tool.schema.spi.JpaTargetAndSourceDescriptor
Imports
org.hibernate.tool.schema.SourceType

Describes a source for schema create, drop and migrate actions.

If getSourceType indicates that a script should be a source, then getScriptSourceInput identifies the script.

The purpose here is also to allow other back-ends (OGM) by simply describing where to find sources rather than defining the sources themselves. The reason being that ultimately the Java type representing a "DDL command" might be different; e.g., String for JDBC.

Author
Steve Ebersole

Method Summary

Modifier and TypeMethod and Description
public ScriptSourceInput

Returns:

The script file to read.
getScriptSourceInput
()

If getSourceType() indicates scripts are involved, returns a representation of the script file to read.

public SourceType

Returns:

The source type
getSourceType
()

The indicated source type for this target type.

Method Detail

getScriptSourceInputback to summary
public ScriptSourceInput getScriptSourceInput()

If getSourceType() indicates scripts are involved, returns a representation of the script file to read. Otherwise, returns null.

While it is ultimately up to the actual tooling provider, it is generally an error for getSourceType() to indicate that scripts are involved and for this method to return null.

Returns:ScriptSourceInput

The script file to read.

getSourceTypeback to summary
public SourceType getSourceType()

The indicated source type for this target type.

Returns:SourceType

The source type