schemacrawler.schemacrawler

Class SchemaReference

java.lang.Object

schemacrawler.schemacrawler.SchemaReference

All Implemented Interfaces:

Serializable, Comparable<NamedObject>, AttributedObject, DescribedObject, NamedObject, Schema

public final class SchemaReference
extends Object
implements Schema

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SchemaReference()
SchemaReference(String catalogName, String schemaName)

Method Summary

Modifier and Type	Method and Description
int	compareTo(NamedObject obj)
boolean	equals(Object obj)
<T> T	getAttribute(String name) Gets an attribute.
<T> T	getAttribute(String name, T defaultValue) Gets an attribute.
Map<String,Object>	getAttributes() Gets all attributes.
String	getCatalogName()
String	getFullName() Getter for fully qualified name of object.
String	getName() Getter for name of object.
String	getRemarks() Getter for remarks.
boolean	hasAttribute(String name) Checks is an attribute is available.
int	hashCode()
boolean	hasRemarks() Whether remarks are available.
NamedObjectKey	key() A value guaranteed to be unique in the database for this object.
<T> Optional<T>	lookupAttribute(String name) Gets an attribute.
void	removeAttribute(String name) Removes an attribute.
void	setAttribute(String name, Object value) Sets an attribute.
void	setRemarks(String remarks) Setter for remarks.
String	toString()
void	withQuoting(Identifiers identifiers) Allows a strategy for quoting identifiers to be considered.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SchemaReference

public SchemaReference()

SchemaReference

public SchemaReference(String catalogName,
                       String schemaName)

Method Detail

compareTo

public int compareTo(NamedObject obj)

Specified by:

compareTo in interface Comparable<NamedObject>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getAttribute

public <T> T getAttribute(String name)

Gets an attribute.

Specified by:

getAttribute in interface AttributedObject

Parameters:

name - Attribute name.

Returns:

Attribute value.

getAttribute

public <T> T getAttribute(String name,
                          T defaultValue)

Gets an attribute.

Specified by:

getAttribute in interface AttributedObject

Parameters:

name - Attribute name.

Returns:

Attribute value.

getAttributes

public Map<String,Object> getAttributes()

Gets all attributes.

Specified by:

getAttributes in interface AttributedObject

Returns:

Map of attributes

getCatalogName

public String getCatalogName()

Specified by:

getCatalogName in interface Schema

getFullName

public String getFullName()

Description copied from interface: NamedObject

Getter for fully qualified name of object.

Specified by:

getFullName in interface NamedObject

Returns:

Fully qualified of the object

getName

public String getName()

Description copied from interface: NamedObject

Getter for name of object.

Specified by:

getName in interface NamedObject

Returns:

Name of the object

getRemarks

public String getRemarks()

Description copied from interface: DescribedObject

Getter for remarks.

Specified by:

getRemarks in interface DescribedObject

Returns:

Remarks

hasAttribute

public boolean hasAttribute(String name)

Checks is an attribute is available.

Specified by:

hasAttribute in interface AttributedObject

Parameters:

name - Attribute name.

Returns:

If attribute is available.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

hasRemarks

public boolean hasRemarks()

Whether remarks are available.

Specified by:

hasRemarks in interface DescribedObject

Returns:

Remarks

key

public NamedObjectKey key()

Description copied from interface: NamedObject

A value guaranteed to be unique in the database for this object.

Specified by:

key in interface NamedObject

lookupAttribute

public <T> Optional<T> lookupAttribute(String name)

Gets an attribute.

Specified by:

lookupAttribute in interface AttributedObject

Parameters:

name - Attribute name.

Returns:

Attribute value.

removeAttribute

public void removeAttribute(String name)

Removes an attribute.

Specified by:

removeAttribute in interface AttributedObject

Parameters:

name - Attribute name

setAttribute

public void setAttribute(String name,
                         Object value)

Sets an attribute.

Specified by:

setAttribute in interface AttributedObject

Parameters:

name - Attribute name

value - Attribute value

setRemarks

public void setRemarks(String remarks)

Description copied from interface: DescribedObject

Setter for remarks.

Specified by:

setRemarks in interface DescribedObject

Parameters:

remarks - Remarks to set

toString

public String toString()

Overrides:

toString in class Object

withQuoting

public void withQuoting(Identifiers identifiers)

Description copied from interface: Schema

Allows a strategy for quoting identifiers to be considered.

Specified by:

withQuoting in interface Schema

Parameters:

identifiers - Identifier quoting strategy.