elemental.js.html

Class JsIDBFactory

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

elemental.js.util.JsElementalBase

elemental.js.dom.JsElementalMixinBase

elemental.js.html.JsIDBFactory

All Implemented Interfaces:

ElementalMixinBase, ElementTraversal, NodeSelector, EventTarget, IDBFactory, ElementTimeControl, SVGExternalResourcesRequired, SVGFilterPrimitiveStandardAttributes, SVGFitToViewBox, SVGLangSpace, SVGLocatable, SVGStylable, SVGTests, SVGTransformable, SVGURIReference, SVGZoomAndPan, Indexable, IndexableInt, IndexableNumber, Mappable, Settable, SettableInt, SettableNumber

public class JsIDBFactory
extends JsElementalMixinBase
implements IDBFactory

Field Summary

Fields inherited from interface elemental.svg.SVGZoomAndPan

SVG_ZOOMANDPAN_DISABLE, SVG_ZOOMANDPAN_MAGNIFY, SVG_ZOOMANDPAN_UNKNOWN

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JsIDBFactory()

Method Summary

Modifier and Type	Method and Description
short	cmp(Object first, Object second) Compares two values as keys to determine equality and ordering for IndexedDB operations, such as storing and iterating.
JsIDBVersionChangeRequest	deleteDatabase(String name) Request deleting a database.
JsIDBRequest	getDatabaseNames()
JsIDBRequest	open(String name) Warning: The description documents the old specification.

Methods inherited from class elemental.js.dom.JsElementalMixinBase

addEventListener, addEventListener, beginElement, beginElementAt, dispatchEvent, endElement, endElementAt, getAnimatedClassName, getAnimatedHeight, getAnimatedHref, getAnimatedResult, getAnimatedTransform, getAnimatedWidth, getAnimatedX, getAnimatedY, getBBox, getChildElementCount, getCTM, getExternalResourcesRequired, getFarthestViewportElement, getFirstElementChild, getLastElementChild, getNearestViewportElement, getNextElementSibling, getPresentationAttribute, getPreserveAspectRatio, getPreviousElementSibling, getRequiredExtensions, getRequiredFeatures, getScreenCTM, getSvgStyle, getSystemLanguage, getTransformToElement, getViewBox, getXmllang, getXmlspace, getZoomAndPan, hasExtension, querySelector, querySelectorAll, removeEventListener, removeEventListener, setXmllang, setXmlspace, setZoomAndPan

Methods inherited from class elemental.js.util.JsElementalBase

at, at, intAt, intAt, length, numberAt, numberAt, setAt, setAt, setAt, setAt, setAt, setAt

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface elemental.util.IndexableInt

intAt, length

Methods inherited from interface elemental.util.IndexableNumber

numberAt

Constructor Detail

JsIDBFactory

protected JsIDBFactory()

Method Detail

cmp

public final short cmp(Object first,
                       Object second)

Description copied from interface: IDBFactory

Compares two values as keys to determine equality and ordering for IndexedDB operations, such as storing and iterating. Do not use this method for comparing arbitrary JavaScript values, because many JavaScript values are either not valid IndexedDB keys (booleans and objects, for example) or are treated as equivalent IndexedDB keys (for example, since IndexedDB ignores arrays with non-numeric properties and treats them as empty arrays, so any non-numeric array are treated as equivalent).

This throws an exception if either of the values is not a valid key.

Parameters

first

The first key to compare.

second

The second key to compare.

Returns

Integer

Returned value	Description
-1	1st key < 2nd
0	1st key = 2nd
1	1st key > 2nd

Exceptions

This method can raise an IDBDatabaseException with the following code:

Attribute	Description
NON_TRANSIENT_ERR	One of the supplied keys was not a valid key.

Specified by:

cmp in interface IDBFactory

deleteDatabase

public final JsIDBVersionChangeRequest deleteDatabase(String name)

Description copied from interface: IDBFactory

Request deleting a database. The method returns an IDBRequest object immediately, and performs the deletion operation asynchronously.

The deletion operation (performed in a different thread) consists of the following steps:

1. If there is no database with the given name, exit successfully.
2. Fire an IDBVersionChangeEvent at all connection objects connected to the named database, with version set to null.
3. If any connection objects connected to the database are still open, fire a blocked event at the request object returned by the deleteDatabase method, using IDBVersionChangeEvent with version set to null.
4. Wait until all open connections to the database are closed.
5. Delete the database.

If the database is successfully deleted, then an IDBSuccessEvent is fired on the request object returned from this method, with its result set to null.

If an error occurs while the database is being deleted, then an error event is fired on the request object that is returned from this method, with its code and message set to appropriate values.

Tip: If the browser you are using hasn't implemented this yet, you can delete the object stores one by one, thus effectively removing the database.

Parameters

name

The name of the database.

Returns

IDBRequest

A request object on which subsequent events related to this request are fired. In the latest draft of the specification, which has not yet been implemented by browsers, the returned object is IDBOpenRequest.

Specified by:

deleteDatabase in interface IDBFactory

getDatabaseNames

public final JsIDBRequest getDatabaseNames()

Specified by:

getDatabaseNames in interface IDBFactory

open

public final JsIDBRequest open(String name)

Description copied from interface: IDBFactory

Warning: The description documents the old specification. Some browsers still implement this method. The specifications have changed, but the changes have not yet been implemented by all browser. See the compatibility table for more information.

Request opening a connection to a database. The method returns an IDBRequest object immediately, and performs the opening operation asynchronously.

The opening operation—which is performed in a separate thread—consists of the following steps:

1. If a database named myAwesomeDatabase already exists:
   • Wait until any existing VERSION_CHANGE transactions have finished.
   • If the database has a deletion pending, wait until it has been deleted.
2. If no database with that name exists, create a database with the provided name, with the empty string as its version, and no object stores.
3. Create a connection to the database.

If the operation is successful, an IDBSuccessEvent is fired on the request object that is returned from this method, with its result attribute set to the new IDBDatabase object for the connection.

If an error occurs while the database connection is being opened, then an error event is fired on the request object returned from this method, with its code and message set to appropriate values.

Parameters

name

The name of the database.

version

The version of the database.

Returns

IDBRequest

A request object on which subsequent events related to this request are fired. In the latest draft of the specification, which has not yet been implemented by browsers, the returned object is IDBOpenRequest.

Specified by:

open in interface IDBFactory