com.screenscraper.datamanager

Class DatabaseSchema

java.lang.Object

com.screenscraper.datamanager.DatabaseSchema

Direct Known Subclasses:

SqlDatabaseSchema

public class DatabaseSchema
extends java.lang.Object

Contains a set of AbstractSchema of all the schemas contained by the DataManager

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<SchemaAttr,java.lang.String>	attrs

Constructor Summary

Constructors

Constructor and Description
DatabaseSchema() Creates a new empty schema
DatabaseSchema(DatabaseSchema other) Returns a copy of the given schema.

Method Summary

Modifier and Type	Method and Description
DatabaseSchema	addAttr(SchemaAttr attr, java.lang.String value) Used for attributes that apply to the database as a whole
DatabaseSchema	addRelationalSchema(RelationalSchema schema) adds a schema to Schemas
java.lang.String	getAttr(SchemaAttr attr) Returns the attribute
java.util.Map<SchemaAttr,java.lang.String>	getAttributes() Returns the attributes as an unmodifiable map
RelationalSchema	getRelationalSchema(java.lang.String name)
java.util.Set<RelationalSchema>	getRelationalSchemas()
boolean	hasRelationalSchema(java.lang.String name) Returns whether or not this has a schema with the given name
boolean	isLimitUsingFetchRows() Returns whether or not this schema should use FETCH FIRST x ROWS for limit results
boolean	isLimitUsingLimit() Returns whether or not this schema should use LIMIT for limiting results
boolean	isLimitUsingTop() Returns whether or not this schema should use TOP for limiting results

Methods inherited from class java.lang.Object

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

Field Detail

attrs

@NotNull
protected final java.util.Map<SchemaAttr,java.lang.String> attrs

Constructor Detail

DatabaseSchema

public DatabaseSchema()

Creates a new empty schema

DatabaseSchema

public DatabaseSchema(@NotNull
                      DatabaseSchema other)

Returns a copy of the given schema. The copy will only be the schema and attributes, not any events that are added.

Parameters:

other - The schema to copy

Method Detail

addAttr

@NotNull
public DatabaseSchema addAttr(SchemaAttr attr,
                                        java.lang.String value)

Used for attributes that apply to the database as a whole

Parameters:

attr - The attribute to add

value - The value for the attribute

Returns:

A reference to this schema, for chaining calls

getAttr

public java.lang.String getAttr(SchemaAttr attr)

Returns the attribute

Parameters:

attr - The attribute to get

Returns:

The attribute, or null if not found

getAttributes

@NotNull
public java.util.Map<SchemaAttr,java.lang.String> getAttributes()

Returns the attributes as an unmodifiable map

Returns:

The attributes

Since:

7.0.10a

isLimitUsingTop

public boolean isLimitUsingTop()

Returns whether or not this schema should use TOP for limiting results

Returns:

Whether or not this schema should use TOP for limiting results

isLimitUsingLimit

public boolean isLimitUsingLimit()

Returns whether or not this schema should use LIMIT for limiting results

Returns:

Whether or not this schema should use LIMIT for limiting results

isLimitUsingFetchRows

public boolean isLimitUsingFetchRows()

Returns whether or not this schema should use FETCH FIRST x ROWS for limit results

Returns:

Whether or not this schema should use FETCH FIRST x ROWS for limiting results

addRelationalSchema

@NotNull
public final DatabaseSchema addRelationalSchema(RelationalSchema schema)

adds a schema to Schemas

Parameters:

schema - The schema to add

Returns:

This for method chaining

getRelationalSchema

@NotNull
public RelationalSchema getRelationalSchema(@Nullable
                                                      java.lang.String name)

Parameters:

name - The name of the schema to retrieve

Returns:

schema corresponding to name, or null

hasRelationalSchema

public boolean hasRelationalSchema(@Nullable
                                   java.lang.String name)

Returns whether or not this has a schema with the given name

Parameters:

name - The name of the schema to look for

Returns:

True if the schema is known, false otherwise

getRelationalSchemas

@NotNull
public java.util.Set<RelationalSchema> getRelationalSchemas()