Module de.seggebaeing.sqlanalyzer

Package de.seggebaeing.sqlanalyzer.logic.bdo

Class SampleQuery

java.lang.Object

de.seggebaeing.sqlanalyzer.logic.bdo.BusinessDomainObject

de.seggebaeing.sqlanalyzer.logic.bdo.SampleQuery

All Implemented Interfaces:

SQLQueryWrapper

public class SampleQuery
extends BusinessDomainObject
implements SQLQueryWrapper

Business domain object (BDO) representing a sample SQL query and its metadata.

Exposes observable JavaFX properties for name, description, reference SQL, prompt context, and SampleQuery.Complexity. Versioning is inherited from BusinessDomainObject and is refreshed when observed properties change (after BusinessDomainObject.registerProperties(javafx.beans.property.Property[]) is called). Implements SQLQueryWrapper.

Since:

1.0

Author:

Felix Seggebäing

Property Summary

Properties

Type	Property	Description
javafx.beans.property.ObjectProperty<SampleQuery.Complexity>	complexity
javafx.beans.property.StringProperty	description
javafx.beans.property.StringProperty	name
javafx.beans.property.StringProperty	promptContext
javafx.beans.property.StringProperty	sql

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SampleQuery.Complexity	Levels of complexity for a sample query.

Constructor Summary

Constructors

Constructor	Description
SampleQuery()	Creates a new SampleQuery with default values.
SampleQuery(String name, String description, String sql, String promptContext, SampleQuery.Complexity complexity)	Creates a new SampleQuery with the given values.
SampleQuery(String name, String description, String sql, String promptContext, SampleQuery.Complexity complexity, Long version)	Creates a new SampleQuery with the given values and an optional version.

Method Summary

Modifier and Type	Method	Description
javafx.beans.property.ObjectProperty<SampleQuery.Complexity>	complexityProperty()
javafx.beans.property.StringProperty	descriptionProperty()
SampleQuery.Complexity	getComplexity()	Gets the value of the complexity property.
String	getDescription()	Gets the value of the description property.
String	getName()	Gets the value of the name property.
String	getPromptContext()	Gets the value of the promptContext property.
String	getSql()	Gets the value of the sql property.
javafx.beans.property.StringProperty	nameProperty()
javafx.beans.property.StringProperty	promptContextProperty()
void	setComplexity(SampleQuery.Complexity complexity)	Sets the value of the complexity property.
void	setDescription(String description)	Sets the value of the description property.
void	setName(String name)	Sets the value of the name property.
void	setPromptContext(String promptContext)	Sets the value of the promptContext property.
void	setSql(String sql)	Sets the value of the sql property.
javafx.beans.property.StringProperty	sqlProperty()
String	toString()	Returns a string representation of this sample query.

Methods inherited from class de.seggebaeing.sqlanalyzer.logic.bdo.BusinessDomainObject

getVersion, refreshVersion, registerProperties, setVersion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Property Details

description

public javafx.beans.property.StringProperty descriptionProperty

See Also:

• getDescription()
• setDescription(String)
• descriptionProperty()

sql

public javafx.beans.property.StringProperty sqlProperty

See Also:

• getSql()
• setSql(String)
• sqlProperty()

name

public javafx.beans.property.StringProperty nameProperty

See Also:

• getName()
• setName(String)
• nameProperty()

promptContext

public javafx.beans.property.StringProperty promptContextProperty

See Also:

• getPromptContext()
• setPromptContext(String)
• promptContextProperty()

complexity

public javafx.beans.property.ObjectProperty<SampleQuery.Complexity> complexityProperty

See Also:

• getComplexity()
• setComplexity(SampleQuery.Complexity)
• complexityProperty()

Constructor Details

SampleQuery

public SampleQuery()

Creates a new SampleQuery with default values.

Initializes all string fields as empty, complexity as null, and the version as null.

SampleQuery

public SampleQuery(String name,
 String description,
 String sql,
 String promptContext,
 SampleQuery.Complexity complexity)

Creates a new SampleQuery with the given values.

Sets the version to null, causing it to be initialized automatically.

Parameters:

name - non-null name

description - non-null description

sql - non-null SQL string

promptContext - non-null prompt context

complexity - non-null complexity level

Throws:

NullPointerException - if any parameter is null

SampleQuery

public SampleQuery(String name,
 String description,
 String sql,
 String promptContext,
 SampleQuery.Complexity complexity,
 Long version)

Creates a new SampleQuery with the given values and an optional version.

Initializes all fields and registers property listeners so that changes automatically refresh the version. If version is null, the version is initialized to the current time.

Parameters:

name - non-null name

description - non-null description

sql - non-null SQL string

promptContext - non-null prompt context

complexity - non-null complexity level

version - initial version value, or null to auto-generate

Throws:

NullPointerException - if any of the string parameters are null

Method Details

toString

public String toString()

Returns a string representation of this sample query.

Format: name.

Overrides:

toString in class Object

Returns:

the name of this sample query

getName

public String getName()

Gets the value of the name property.

Property description:

Returns:

the value of the name property

See Also:

• setName(String)
• nameProperty()

getDescription

public String getDescription()

Gets the value of the description property.

Property description:

Returns:

the value of the description property

See Also:

• setDescription(String)
• descriptionProperty()

descriptionProperty

public javafx.beans.property.StringProperty descriptionProperty()

Returns:

the description property

See Also:

• getDescription()
• setDescription(String)

getPromptContext

public String getPromptContext()

Gets the value of the promptContext property.

Property description:

Returns:

the value of the promptContext property

See Also:

• setPromptContext(String)
• promptContextProperty()

getSql

public String getSql()

Gets the value of the sql property.

Specified by:

getSql in interface SQLQueryWrapper

Property description:

Returns:

the value of the sql property

See Also:

• setSql(String)
• sqlProperty()

getComplexity

public SampleQuery.Complexity getComplexity()

Gets the value of the complexity property.

Property description:

Returns:

the value of the complexity property

See Also:

• setComplexity(SampleQuery.Complexity)
• complexityProperty()

sqlProperty

public javafx.beans.property.StringProperty sqlProperty()

Returns:

the sql property

See Also:

• getSql()
• setSql(String)

nameProperty

public javafx.beans.property.StringProperty nameProperty()

Returns:

the name property

See Also:

• getName()
• setName(String)

promptContextProperty

public javafx.beans.property.StringProperty promptContextProperty()

Returns:

the promptContext property

See Also:

• getPromptContext()
• setPromptContext(String)

complexityProperty

public javafx.beans.property.ObjectProperty<SampleQuery.Complexity> complexityProperty()

Returns:

the complexity property

See Also:

• getComplexity()
• setComplexity(SampleQuery.Complexity)

setName

public void setName(String name)

Sets the value of the name property.

Property description:

Parameters:

name - the value for the name property

See Also:

• getName()
• nameProperty()

setDescription

public void setDescription(String description)

Sets the value of the description property.

Property description:

Parameters:

description - the value for the description property

See Also:

• getDescription()
• descriptionProperty()

setSql

public void setSql(String sql)

Sets the value of the sql property.

Property description:

Parameters:

sql - the value for the sql property

See Also:

• getSql()
• sqlProperty()

setPromptContext

public void setPromptContext(String promptContext)

Sets the value of the promptContext property.

Property description:

Parameters:

promptContext - the value for the promptContext property

See Also:

• getPromptContext()
• promptContextProperty()

setComplexity

public void setComplexity(SampleQuery.Complexity complexity)

Sets the value of the complexity property.

Property description:

Parameters:

complexity - the value for the complexity property

See Also:

• getComplexity()
• complexityProperty()