From: Vyacheslav Tyutyunkov Date: Mon, 1 Apr 2013 06:13:50 +0000 (+0700) Subject: #21 X-Git-Tag: v1.2.12~376 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=d3bfe27a8fb003cf27b4be1e33a05e9d4ec2a88b;p=platform%2Fupstream%2Fejdb.git #21 --- diff --git a/jejdb/Makefile b/jejdb/Makefile index 939a224..eb6e196 100644 --- a/jejdb/Makefile +++ b/jejdb/Makefile @@ -28,7 +28,7 @@ SRCDIR = ./src/cpp/ # Building configuration CC = gcc -CPPFLAGS = -I. -I. -I../tcejdb -I/usr/lib/jvm/java-6-openjdk-amd64/include -I/usr/lib/jvm/java-6-openjdk-amd64/include/linux -I$(INCLUDEDIR) -I/home/tve/include -I/usr/local/include -D_UNICODE -DNDEBUG -D_GNU_SOURCE=1 -D_REENTRANT -D__EXTENSIONS__ +CPPFLAGS = -I. -I. -I../tcejdb -I/usr/lib/jvm/java-6-oracle//include -I/usr/lib/jvm/java-6-oracle//include/linux -I$(INCLUDEDIR) -I/home/tve/include -I/usr/local/include -D_UNICODE -DNDEBUG -D_GNU_SOURCE=1 -D_REENTRANT -D__EXTENSIONS__ CFLAGS = -std=c99 -Wall -fPIC -fsigned-char -O2 LDFLAGS = -L. -L$(LIBDIR) -L/home/tve/lib -L/usr/local/lib LIBS = -lz -ltcejdb -lrt -lpthread -lm -lc @@ -70,6 +70,7 @@ install: clean: rm -rf $(LIBRARYFILES) + ant clean #================================================================ diff --git a/jejdb/Makefile.in b/jejdb/Makefile.in index 6e2a89e..ce6e42f 100644 --- a/jejdb/Makefile.in +++ b/jejdb/Makefile.in @@ -70,6 +70,7 @@ install: clean: rm -rf $(LIBRARYFILES) + ant clean #================================================================ diff --git a/jejdb/build.properties b/jejdb/build.properties index f07c583..46ba0a0 100644 --- a/jejdb/build.properties +++ b/jejdb/build.properties @@ -4,7 +4,7 @@ distr.name=jejdb-${distr.version} distr.base=${basedir}/target distr.home=${distr.base} distr.lib=${distr.base}/lib -distr.doc=${distr.home}/doc +distr.doc=${basedir}/doc build.dir=${basedir}/build build.classes=${build.dir}/classes diff --git a/jejdb/build.xml b/jejdb/build.xml index f50a344..8c1d9fa 100644 --- a/jejdb/build.xml +++ b/jejdb/build.xml @@ -14,9 +14,6 @@ encoding="${javac.encoding}" includeantruntime="false"> - - - @@ -26,9 +23,6 @@ - - - @@ -47,7 +41,6 @@ includeantruntime="false"> - @@ -60,9 +53,6 @@ - - - @@ -71,7 +61,6 @@ - @@ -91,7 +80,6 @@ - @@ -101,12 +89,6 @@ - - - - - - @@ -117,7 +99,7 @@ - + @@ -135,21 +117,19 @@ + + Windowtitle="JEJDB Doc"> - - - diff --git a/jejdb/doc/allclasses-frame.html b/jejdb/doc/allclasses-frame.html new file mode 100644 index 0000000..e5bab06 --- /dev/null +++ b/jejdb/doc/allclasses-frame.html @@ -0,0 +1,64 @@ + + + + + + + +All Classes (JEJDB Doc) + + + + + + + + + + + +All Classes +
+ + + + + +
BSON +
+BSONException +
+BSONObject +
+BSONQueryObject +
+EJDB +
+EJDBCollection +
+EJDBCollection.Index +
+EJDBCollection.IndexType +
+EJDBCollection.Options +
+EJDBException +
+EJDBQuery +
+EJDBQueryBuilder +
+EJDBResultSet +
+InputBuffer +
+ObjectId +
+OutputBuffer +
+RegexFlag +
+
+ + + diff --git a/jejdb/doc/allclasses-noframe.html b/jejdb/doc/allclasses-noframe.html new file mode 100644 index 0000000..c1798a3 --- /dev/null +++ b/jejdb/doc/allclasses-noframe.html @@ -0,0 +1,64 @@ + + + + + + + +All Classes (JEJDB Doc) + + + + + + + + + + + +All Classes +
+ + + + + +
BSON +
+BSONException +
+BSONObject +
+BSONQueryObject +
+EJDB +
+EJDBCollection +
+EJDBCollection.Index +
+EJDBCollection.IndexType +
+EJDBCollection.Options +
+EJDBException +
+EJDBQuery +
+EJDBQueryBuilder +
+EJDBResultSet +
+InputBuffer +
+ObjectId +
+OutputBuffer +
+RegexFlag +
+
+ + + diff --git a/jejdb/doc/constant-values.html b/jejdb/doc/constant-values.html new file mode 100644 index 0000000..42a535e --- /dev/null +++ b/jejdb/doc/constant-values.html @@ -0,0 +1,439 @@ + + + + + + + +Constant Field Values (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Constant Field Values

+
+
+Contents + + + + + + +
+org.ejdb.*
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
org.ejdb.bson.BSON
+public static final byteARRAY4
+public static final byteBINARY5
+public static final byteBOOLEAN8
+public static final byteDATE9
+public static final byteDOUBLE1
+public static final byteINT16
+public static final byteLONG17
+public static final byteNULL10
+public static final byteOBJECT3
+public static final byteOBJECT_ID7
+public static final byteREGEX11
+public static final byteSTRING2
+ +

+ +

+ + + + + + + + + + + + +
org.ejdb.bson.BSONObject
+public static final java.lang.StringID_KEY"_id"
+ +

+ +

+ + + + + + + + + + + + +
org.ejdb.bson.io.OutputBuffer
+public static final intBUFFER_DEFAULT_LENGTH512
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
org.ejdb.driver.EJDB
+public static final intJBO_DEFAULT70
+public static final intJBOCREAT4
+public static final intJBOLCKNB32
+public static final intJBONOLCK16
+public static final intJBOREADER1
+public static final intJBOTRUNC8
+public static final intJBOTSYNC64
+public static final intJBOWRITER2
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
org.ejdb.driver.EJDBCollection
+public static final intJBIDXARR64
+public static final intJBIDXDROP1
+public static final intJBIDXDROPALL2
+public static final intJBIDXISTR128
+public static final intJBIDXNUM16
+public static final intJBIDXOP4
+public static final intJBIDXREBLD8
+public static final intJBIDXSTR32
+protected static final intJBTXBEGIN1
+protected static final intJBTXCOMMIT2
+protected static final intJBTXROLLBACK4
+protected static final intJBTXSTATUS8
+ +

+ +

+ + + + + + + + + + + + +
org.ejdb.driver.EJDBQuery
+protected static final intJBQRYCOUNT1
+ +

+ +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/deprecated-list.html b/jejdb/doc/deprecated-list.html new file mode 100644 index 0000000..2725831 --- /dev/null +++ b/jejdb/doc/deprecated-list.html @@ -0,0 +1,182 @@ + + + + + + + +Deprecated List (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Deprecated API

+
+
+Contents + + + + + + + + + + + + + + + + + + + + + +
+Deprecated Methods
org.ejdb.driver.EJDBCollection.createQuery(BSONObject) +
+            
org.ejdb.driver.EJDBCollection.createQuery(BSONObject, BSONObject) +
+            
org.ejdb.driver.EJDBCollection.createQuery(BSONObject, BSONObject[]) +
+            
org.ejdb.driver.EJDBCollection.createQuery(BSONObject, BSONObject[], BSONObject) +
+            
org.ejdb.driver.BSONQueryObject.getId() +
+          BSON Query objects can not contains dedicated ObjectID 
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/help-doc.html b/jejdb/doc/help-doc.html new file mode 100644 index 0000000..2f2cfb7 --- /dev/null +++ b/jejdb/doc/help-doc.html @@ -0,0 +1,224 @@ + + + + + + + +API Help (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+How This API Document Is Organized

+
+This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

+Overview

+
+ +

+The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

+

+Package

+
+ +

+Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

    +
  • Interfaces (italic)
  • Classes
  • Enums
  • Exceptions
  • Errors
  • Annotation Types
+
+

+Class/Interface

+
+ +

+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

    +
  • Class inheritance diagram
  • Direct Subclasses
  • All Known Subinterfaces
  • All Known Implementing Classes
  • Class/interface declaration
  • Class/interface description +

    +

  • Nested Class Summary
  • Field Summary
  • Constructor Summary
  • Method Summary +

    +

  • Field Detail
  • Constructor Detail
  • Method Detail
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+ +

+Annotation Type

+
+ +

+Each annotation type has its own separate page with the following sections:

    +
  • Annotation Type declaration
  • Annotation Type description
  • Required Element Summary
  • Optional Element Summary
  • Element Detail
+
+ +

+Enum

+
+ +

+Each enum has its own separate page with the following sections:

    +
  • Enum declaration
  • Enum description
  • Enum Constant Summary
  • Enum Constant Detail
+
+

+Use

+
+Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
+

+Tree (Class Hierarchy)

+
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
    +
  • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
  • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
+
+

+Deprecated API

+
+The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+

+Index

+
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+

+Prev/Next

+These links take you to the next or previous class, interface, package, or related page.

+Frames/No Frames

+These links show and hide the HTML frames. All pages are available with or without frames. +

+

+Serialized Form

+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. +

+

+Constant Field Values

+The Constant Field Values page lists the static final fields and their values. +

+ + +This help file applies to API documentation generated using the standard doclet. + +
+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/index-all.html b/jejdb/doc/index-all.html new file mode 100644 index 0000000..8bba8a9 --- /dev/null +++ b/jejdb/doc/index-all.html @@ -0,0 +1,1056 @@ + + + + + + + +Index (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +A B C D E F G H I J L N O P R S T U V W
+

+A

+
+
add(String, boolean) - +Method in class org.ejdb.driver.EJDBQueryBuilder.OrderBy +
Add sorting order for field +
addHint(String, Object) - +Method in class org.ejdb.driver.EJDBQueryBuilder +
Adds pair name->value to hints BSON object. +
addOperation(String, Object, boolean) - +Method in class org.ejdb.driver.EJDBQueryBuilder +
Adds query restrintions in main query object. +
addOperation(Object) - +Method in class org.ejdb.driver.EJDBQueryBuilder.Constraint +
Add curently restrictons tree to query +
addToBSON(BSONObject, String, Object) - +Method in class org.ejdb.driver.EJDBQueryBuilder +
  +
addToSet(String, Object) - +Method in class org.ejdb.driver.EJDBQueryBuilder +
Atomically adds value to the array field only if value not in the array already. +
addToSetAll(String, Object...) - +Method in class org.ejdb.driver.EJDBQueryBuilder +
Atomically performs set union with values in val for specified array field. +
addToSetAll(String, Collection<Object>) - +Method in class org.ejdb.driver.EJDBQueryBuilder +
Atomically performs set union with values in val for specified array field. +
append(String, Object) - +Method in class org.ejdb.bson.BSONObject +
The same as BSONObject.put(String, Object) but return this +
append(String, Object) - +Method in class org.ejdb.driver.BSONQueryObject +
The same as BSONObject.put(String, Object) but return this +
ARRAY - +Static variable in class org.ejdb.bson.BSON +
  +
asc(String) - +Method in class org.ejdb.driver.EJDBQueryBuilder.OrderBy +
Add ascending sorting order for field +
+
+

+B

+
+
begin(String) - +Method in class org.ejdb.driver.EJDBQueryBuilder.Constraint +
Strins starts with prefix +
beginTransaction() - +Method in class org.ejdb.driver.EJDBCollection +
Begin collection transaction. +
BINARY - +Static variable in class org.ejdb.bson.BSON +
  +
BOOLEAN - +Static variable in class org.ejdb.bson.BSON +
  +
BSON - Class in org.ejdb.bson
Util class for encode/decode BSON objects
BSONException - Exception in org.ejdb.bson
 
BSONException() - +Constructor for exception org.ejdb.bson.BSONException +
  +
BSONException(String) - +Constructor for exception org.ejdb.bson.BSONException +
  +
BSONException(String, Throwable) - +Constructor for exception org.ejdb.bson.BSONException +
  +
BSONException(Throwable) - +Constructor for exception org.ejdb.bson.BSONException +
  +
BSONObject - Class in org.ejdb.bson
BSON object.
BSONObject() - +Constructor for class org.ejdb.bson.BSONObject +
Constructs new BSON object +
BSONObject(ObjectId) - +Constructor for class org.ejdb.bson.BSONObject +
Constructs new BSON object with specified id +
BSONObject(String, Object) - +Constructor for class org.ejdb.bson.BSONObject +
Constructs new BSON object with initial data. +
BSONObject(Map<String, Object>) - +Constructor for class org.ejdb.bson.BSONObject +
Constructs new BSON object and init data from specified Map. +
BSONObject(BSONObject) - +Constructor for class org.ejdb.bson.BSONObject +
Constructs new BSON object as copy of other BSON object. +
BSONQueryObject - Class in org.ejdb.driver
BSON object for EJDB queries (limitation checks for BSONObject.ID_KEY field)
BSONQueryObject() - +Constructor for class org.ejdb.driver.BSONQueryObject +
  +
BSONQueryObject(String, Object) - +Constructor for class org.ejdb.driver.BSONQueryObject +
  +
BSONQueryObject(Map<String, Object>) - +Constructor for class org.ejdb.driver.BSONQueryObject +
  +
BSONQueryObject(BSONObject) - +Constructor for class org.ejdb.driver.BSONQueryObject +
  +
bt(Number, Number) - +Method in class org.ejdb.driver.EJDBQueryBuilder.Constraint +
Between number (start <= field_value <= end) +
BUFFER_DEFAULT_LENGTH - +Static variable in class org.ejdb.bson.io.OutputBuffer +
  +
+
+

+C

+
+
checkHintsAvailable() - +Method in class org.ejdb.driver.EJDBQueryBuilder +
Checks hints section allowed. +
clear() - +Method in class org.ejdb.bson.BSONObject +
Removes all fields +
clear() - +Method in class org.ejdb.driver.EJDBQueryBuilder.OrderBy +
Clear all current sorting rules +
close() - +Method in class org.ejdb.driver.EJDB +
Close database. +
close() - +Method in class org.ejdb.driver.EJDBResultSet +
Close result set +
commitTransaction() - +Method in class org.ejdb.driver.EJDBCollection +
Commit collection transaction. +
containsField(String) - +Method in class org.ejdb.bson.BSONObject +
Checks field contains in BSON object +
count() - +Method in class org.ejdb.driver.EJDBQuery +
Convenient count(*) operation +
count(OutputStream) - +Method in class org.ejdb.driver.EJDBQuery +
Convenient count(*) operation +
createFromByteArray(byte[]) - +Static method in class org.ejdb.bson.io.InputBuffer +
Creates InputBuffer from byte array +
createQuery(EJDBQueryBuilder) - +Method in class org.ejdb.driver.EJDBCollection +
Creates new EJDB Query for current collection. +
createQuery(BSONObject) - +Method in class org.ejdb.driver.EJDBCollection +
Deprecated.   +
createQuery(BSONObject, BSONObject[]) - +Method in class org.ejdb.driver.EJDBCollection +
Deprecated.   +
createQuery(BSONObject, BSONObject) - +Method in class org.ejdb.driver.EJDBCollection +
Deprecated.   +
createQuery(BSONObject, BSONObject[], BSONObject) - +Method in class org.ejdb.driver.EJDBCollection +
Deprecated.   +
+
+

+D

+
+
data - +Variable in class org.ejdb.bson.BSONObject +
  +
DATE - +Static variable in class org.ejdb.bson.BSON +
  +
decode(byte[]) - +Static method in class org.ejdb.bson.BSON +
Decode BSON object from plain byte array +
desc(String) - +Method in class org.ejdb.driver.EJDBQueryBuilder.OrderBy +
Add descinding sorting order for field +
DOUBLE - +Static variable in class org.ejdb.bson.BSON +
  +
drop() - +Method in class org.ejdb.driver.EJDBCollection +
Drop collection. +
drop(boolean) - +Method in class org.ejdb.driver.EJDBCollection +
Drop collection. +
dropAll() - +Method in class org.ejdb.driver.EJDBQueryBuilder +
In-place record removal operation. +
dropArrayIndex(String) - +Method in class org.ejdb.driver.EJDBCollection +
Drop index of Array type for BSON field path. +
dropCollection(String) - +Method in class org.ejdb.driver.EJDB +
Drop collection by name. +
dropCollection(String, boolean) - +Method in class org.ejdb.driver.EJDB +
Drop collection. +
dropIndexes(String) - +Method in class org.ejdb.driver.EJDBCollection +
Drops indexes of all types for BSON field path. +
dropIStringIndex(String) - +Method in class org.ejdb.driver.EJDBCollection +
Drop case insensitive String index for BSON field path. +
dropNumderIndex(String) - +Method in class org.ejdb.driver.EJDBCollection +
Drop index of Number type for BSON field path. +
dropStringIndex(String) - +Method in class org.ejdb.driver.EJDBCollection +
Drop index of String type for BSON field path. +
+
+

+E

+
+
EJDB - Class in org.ejdb.driver
 
EJDB() - +Constructor for class org.ejdb.driver.EJDB +
  +
EJDBCollection - Class in org.ejdb.driver
 
EJDBCollection.Index - Class in org.ejdb.driver
Index meta information
EJDBCollection.Index() - +Constructor for class org.ejdb.driver.EJDBCollection.Index +
  +
EJDBCollection.IndexType - Enum in org.ejdb.driver
Index types
EJDBCollection.Options - Class in org.ejdb.driver
Collection meta information (and creation options)
EJDBCollection.Options() - +Constructor for class org.ejdb.driver.EJDBCollection.Options +
  +
EJDBCollection.Options(boolean, boolean, long, int) - +Constructor for class org.ejdb.driver.EJDBCollection.Options +
  +
EJDBException - Exception in org.ejdb.driver
 
EJDBException() - +Constructor for exception org.ejdb.driver.EJDBException +
  +
EJDBException(String) - +Constructor for exception org.ejdb.driver.EJDBException +
  +
EJDBException(String, Throwable) - +Constructor for exception org.ejdb.driver.EJDBException +
  +
EJDBException(Throwable) - +Constructor for exception org.ejdb.driver.EJDBException +
  +
EJDBException(int, String) - +Constructor for exception org.ejdb.driver.EJDBException +
  +
EJDBQuery - Class in org.ejdb.driver
EJDB Query object.
EJDBQueryBuilder - Class in org.ejdb.driver
Query/BSON builder is used to create EJDB queries.
EJDBQueryBuilder() - +Constructor for class org.ejdb.driver.EJDBQueryBuilder +
  +
EJDBQueryBuilder(BSONObject, List<BSONObject>, BSONObject) - +Constructor for class org.ejdb.driver.EJDBQueryBuilder +
  +
EJDBQueryBuilder(EJDBQueryBuilder, BSONObject) - +Constructor for class org.ejdb.driver.EJDBQueryBuilder +
  +
EJDBQueryBuilder.Constraint - Class in org.ejdb.driver
Find constraint for specified field
EJDBQueryBuilder.Constraint(String) - +Constructor for class org.ejdb.driver.EJDBQueryBuilder.Constraint +
  +
EJDBQueryBuilder.Constraint(String, boolean) - +Constructor for class org.ejdb.driver.EJDBQueryBuilder.Constraint +
  +
EJDBQueryBuilder.Constraint(String, EJDBQueryBuilder.Constraint) - +Constructor for class org.ejdb.driver.EJDBQueryBuilder.Constraint +
  +
EJDBQueryBuilder.OrderBy - Class in org.ejdb.driver
Sorting rules for query results
EJDBQueryBuilder.OrderBy(BSONObject) - +Constructor for class org.ejdb.driver.EJDBQueryBuilder.OrderBy +
  +
EJDBResultSet - Class in org.ejdb.driver
 
elementMatch(String) - +Method in class org.ejdb.driver.EJDBQueryBuilder +
Element match construction +
encode(BSONObject) - +Static method in class org.ejdb.bson.BSON +
Encode BSON object to plain byte array +
ensure(int) - +Method in class org.ejdb.bson.io.InputBuffer +
Checks is buffer contains needed bytes +
ensureArrayIndex(String) - +Method in class org.ejdb.driver.EJDBCollection +
Ensure index presence of Array type for BSON field path +
ensureCollection(String) - +Method in class org.ejdb.driver.EJDB +
Automatically creates new collection if it does't exists with using default collection options +
ensureCollection(String, EJDBCollection.Options) - +Method in class org.ejdb.driver.EJDB +
Automatically creates new collection if it does't exists. +
ensureExists() - +Method in class org.ejdb.driver.EJDBCollection +
Automatically creates new collection if it does't exists with using default collection options. +
ensureExists(EJDBCollection.Options) - +Method in class org.ejdb.driver.EJDBCollection +
Automatically creates new collection if it does't exists. +
ensureIStringIndex(String) - +Method in class org.ejdb.driver.EJDBCollection +
Ensure case insensitive String index for BSON field path +
ensureLength(int) - +Method in class org.ejdb.bson.io.OutputBuffer +
Checks internal array size to hold needed data and expand it if need. +
ensureNumderIndex(String) - +Method in class org.ejdb.driver.EJDBCollection +
Ensure index presence of Number type for BSON field path +
ensureStringIndex(String) - +Method in class org.ejdb.driver.EJDBCollection +
Ensure index presence of String type for BSON field path +
eq(Object) - +Method in class org.ejdb.driver.EJDBQueryBuilder.Constraint +
Field equality restriction. +
equals(Object) - +Method in class org.ejdb.bson.BSONObject +
+
equals(Object) - +Method in class org.ejdb.bson.types.ObjectId +
+
excludeField(String) - +Method in class org.ejdb.driver.EJDBQueryBuilder +
Sets fields to be excluded from resulting objects. +
execute(BSONObject, int, OutputStream) - +Method in class org.ejdb.driver.EJDBQuery +
  +
execute(BSONObject, BSONObject[], BSONObject, int, OutputStream) - +Method in class org.ejdb.driver.EJDBQuery +
  +
exists() - +Method in class org.ejdb.driver.EJDBQueryBuilder.Constraint +
Field existence matching EJDBQueryBuilder.Constraint.exists(boolean) +
exists(boolean) - +Method in class org.ejdb.driver.EJDBQueryBuilder.Constraint +
Field existence matching +
+
+

+F

+
+
field(String) - +Method in class org.ejdb.driver.EJDBQueryBuilder.Constraint +
Add inner constraint +
field(String, Object) - +Method in class org.ejdb.driver.EJDBQueryBuilder +
Adds field equality restriction. +
field(String) - +Method in class org.ejdb.driver.EJDBQueryBuilder +
Adds constraint for field +
fields - +Variable in class org.ejdb.bson.BSONObject +
  +
fields() - +Method in class org.ejdb.bson.BSONObject +
Returns fields in adding order +
finalize() - +Method in class org.ejdb.driver.EJDB +
+
finalize() - +Method in class org.ejdb.driver.EJDBResultSet +
+
find() - +Method in class org.ejdb.driver.EJDBQuery +
Execute query +
find(OutputStream) - +Method in class org.ejdb.driver.EJDBQuery +
Execute query +
findOne() - +Method in class org.ejdb.driver.EJDBQuery +
Same as EJDBQuery.find() but retrieves only one matching JSON object. +
findOne(OutputStream) - +Method in class org.ejdb.driver.EJDBQuery +
Same as EJDBQuery.find() but retrieves only one matching JSON object. +
+
+

+G

+
+
get(String) - +Method in class org.ejdb.bson.BSONObject +
Returns value of specified field if exists, or null otherwise +
get(int) - +Method in class org.ejdb.driver.EJDBResultSet +
Returns object by position +
getActualSize() - +Method in class org.ejdb.bson.io.OutputBuffer +
Returns actual (full) size of buffer (currently writed bytes) +
getBuckets() - +Method in class org.ejdb.driver.EJDBCollection.Options +
  +
getCachedRecords() - +Method in class org.ejdb.driver.EJDBCollection.Options +
  +
getCharacter() - +Method in class org.ejdb.bson.util.RegexFlag +
Returns BSON character for associated Java regex flag +
getCode() - +Method in exception org.ejdb.driver.EJDBException +
  +
getCollection(String) - +Method in class org.ejdb.driver.EJDB +
Returns collection object (without automatical creation) +
getCollection(String, boolean) - +Method in class org.ejdb.driver.EJDB +
Returns collection object +
getCollection(String, boolean, EJDBCollection.Options) - +Method in class org.ejdb.driver.EJDB +
Returns collection object +
getCollectionNames() - +Method in class org.ejdb.driver.EJDB +
Returns names of existed collections +
getCollections() - +Method in class org.ejdb.driver.EJDB +
Returns collection objects for all existed collections +
getDB() - +Method in class org.ejdb.driver.EJDBCollection +
Returns EJDB object +
getField() - +Method in class org.ejdb.driver.EJDBCollection.Index +
Returns index field path +
getFile() - +Method in class org.ejdb.driver.EJDBCollection.Index +
Returns index file path +
getFlag() - +Method in class org.ejdb.bson.util.RegexFlag +
Returns Java flag +
getId() - +Method in class org.ejdb.bson.BSONObject +
Returns id of BSON object (if specified) +
getId() - +Method in class org.ejdb.driver.BSONQueryObject +
Deprecated. BSON Query objects can not contains dedicated ObjectID +
getIndexes() - +Method in class org.ejdb.driver.EJDBCollection +
Returns indexes info +
getMainQuery() - +Method in class org.ejdb.driver.EJDBQueryBuilder +
Returns main BSON query object +
getName() - +Method in class org.ejdb.driver.EJDBCollection +
Returns collection name +
getName() - +Method in class org.ejdb.driver.EJDBCollection.Index +
Returns index name +
getOptions() - +Method in class org.ejdb.driver.EJDBCollection +
Returns collection options EJDBCollection.Options +
getOrQueries() - +Method in class org.ejdb.driver.EJDBQueryBuilder +
Returns BSON objects for additional OR queries +
getPath() - +Method in class org.ejdb.driver.EJDB +
Returns EJDB path +
getPosition() - +Method in class org.ejdb.bson.io.OutputBuffer +
Returns current position in output +
getQueryHints() - +Method in class org.ejdb.driver.EJDBQueryBuilder +
Returns BSON hints object +
getRecords() - +Method in class org.ejdb.driver.EJDBCollection.Index +
Returns records count in index +
getResult() - +Method in class org.ejdb.bson.io.OutputBuffer +
Returns buffer as byte array +
getType() - +Method in class org.ejdb.driver.EJDBCollection.Index +
Returns index type +
gt(Number) - +Method in class org.ejdb.driver.EJDBQueryBuilder.Constraint +
Greater than value (field_value > value) +
gte(Number) - +Method in class org.ejdb.driver.EJDBQueryBuilder.Constraint +
Greater than or equal value (field_value >= value) +
+
+

+H

+
+
hashCode() - +Method in class org.ejdb.bson.BSONObject +
+
hashCode() - +Method in class org.ejdb.bson.types.ObjectId +
+
hasNext() - +Method in class org.ejdb.driver.EJDBResultSet +
+
+
+

+I

+
+
icase() - +Method in class org.ejdb.driver.EJDBQueryBuilder.Constraint +
Case insensitive string matching +

+ Example: + query.field(field).icase().eq(value); // -> {field : {$icase : value}} + query.field(field).icase().in(value1, value2); // -> {field : {$icase : {$in : [value1, value2]}}} +

ID_KEY - +Static variable in class org.ejdb.bson.BSONObject +
ID-field name +
in(Object[]) - +Method in class org.ejdb.driver.EJDBQueryBuilder.Constraint +
Field value matched any value of specified in values. +
in(Collection<Object>) - +Method in class org.ejdb.driver.EJDBQueryBuilder.Constraint +
Field value matched any value of specified in values. +
inc(String, Number) - +Method in class org.ejdb.driver.EJDBQueryBuilder +
Increment specified field. +
includeField(String) - +Method in class org.ejdb.driver.EJDBQueryBuilder +
Sets fields to be included in resulting objects. +
InputBuffer - Class in org.ejdb.bson.io
Utility class for reading BSON object data from byte array
INT - +Static variable in class org.ejdb.bson.BSON +
  +
isAvailable() - +Method in class org.ejdb.bson.io.InputBuffer +
Returns true if any bytes available to read from buffer or false otherwise +
isCompressed() - +Method in class org.ejdb.driver.EJDBCollection.Options +
  +
isExists() - +Method in class org.ejdb.driver.EJDBCollection +
Returns collection exists status +
isFieldsOrderImportant() - +Method in class org.ejdb.bson.BSONObject +
If returns true fields order will be checks on equal. +
isFieldsOrderImportant() - +Method in class org.ejdb.driver.BSONQueryObject +
If returns true fields order will be checks on equal. +
isLarge() - +Method in class org.ejdb.driver.EJDBCollection.Options +
  +
isOpen() - +Method in class org.ejdb.driver.EJDB +
Check if database in opened state. +
isSupported() - +Method in class org.ejdb.bson.util.RegexFlag +
Returns true if BSON supported current Java flag +
isTransactionActive() - +Method in class org.ejdb.driver.EJDBCollection +
Get collection transaction status. +
isValid(String) - +Static method in class org.ejdb.bson.types.ObjectId +
Checks string on valid ObjectId data +
iterator() - +Method in class org.ejdb.driver.EJDBResultSet +
+
+
+

+J

+
+
JBIDXARR - +Static variable in class org.ejdb.driver.EJDBCollection +
Array token index. +
JBIDXDROP - +Static variable in class org.ejdb.driver.EJDBCollection +
Drop index. +
JBIDXDROPALL - +Static variable in class org.ejdb.driver.EJDBCollection +
Drop index for all types. +
JBIDXISTR - +Static variable in class org.ejdb.driver.EJDBCollection +
Case insensitive string index +
JBIDXNUM - +Static variable in class org.ejdb.driver.EJDBCollection +
Number index. +
JBIDXOP - +Static variable in class org.ejdb.driver.EJDBCollection +
Optimize index. +
JBIDXREBLD - +Static variable in class org.ejdb.driver.EJDBCollection +
Rebuild index. +
JBIDXSTR - +Static variable in class org.ejdb.driver.EJDBCollection +
String index. +
JBO_DEFAULT - +Static variable in class org.ejdb.driver.EJDB +
Default open mode +
JBOCREAT - +Static variable in class org.ejdb.driver.EJDB +
Create if db file not exists. +
JBOLCKNB - +Static variable in class org.ejdb.driver.EJDB +
Lock without blocking. +
JBONOLCK - +Static variable in class org.ejdb.driver.EJDB +
Open without locking. +
JBOREADER - +Static variable in class org.ejdb.driver.EJDB +
Open as a reader. +
JBOTRUNC - +Static variable in class org.ejdb.driver.EJDB +
Truncate db on open. +
JBOTSYNC - +Static variable in class org.ejdb.driver.EJDB +
Synchronize every transaction. +
JBOWRITER - +Static variable in class org.ejdb.driver.EJDB +
Open as a writer. +
JBQRYCOUNT - +Static variable in class org.ejdb.driver.EJDBQuery +
  +
JBTXBEGIN - +Static variable in class org.ejdb.driver.EJDBCollection +
  +
JBTXCOMMIT - +Static variable in class org.ejdb.driver.EJDBCollection +
  +
JBTXROLLBACK - +Static variable in class org.ejdb.driver.EJDBCollection +
  +
JBTXSTATUS - +Static variable in class org.ejdb.driver.EJDBCollection +
  +
join(String, String) - +Method in class org.ejdb.driver.EJDBQueryBuilder +
Make collection join for select queries. +
+
+

+L

+
+
length() - +Method in class org.ejdb.driver.EJDBResultSet +
Returns objects count in result set +
load(ObjectId) - +Method in class org.ejdb.driver.EJDBCollection +
Loads BSON object identified by OID from the collection. +
LONG - +Static variable in class org.ejdb.bson.BSON +
  +
lt(Number) - +Method in class org.ejdb.driver.EJDBQueryBuilder.Constraint +
Lesser then value (field_value < value) +
lte(Number) - +Method in class org.ejdb.driver.EJDBQueryBuilder.Constraint +
Lesser then or equal value (field_value <= value) +
+
+

+N

+
+
next() - +Method in class org.ejdb.driver.EJDBResultSet +
+
not() - +Method in class org.ejdb.driver.EJDBQueryBuilder.Constraint +
Add $not negatiation constraint +

+ Example: + query.field(field).not().eq(value); // {field : { $not : value }} + query.field(field).not().bt(start, end); // {field : { $not : {$bt : [start, end]}}} +

notIn(Object[]) - +Method in class org.ejdb.driver.EJDBQueryBuilder.Constraint +
Negation of EJDBQueryBuilder.Constraint.in(Object...) +
notIn(Collection<Object>) - +Method in class org.ejdb.driver.EJDBQueryBuilder.Constraint +
Negation of EJDBQueryBuilder.Constraint.in(java.util.Collection) +
NULL - +Static variable in class org.ejdb.bson.BSON +
  +
+
+

+O

+
+
OBJECT - +Static variable in class org.ejdb.bson.BSON +
  +
OBJECT_ID - +Static variable in class org.ejdb.bson.BSON +
  +
ObjectId - Class in org.ejdb.bson.types
BSON Object ID
ObjectId(byte[]) - +Constructor for class org.ejdb.bson.types.ObjectId +
Read ObjectId from byte array +
ObjectId(String) - +Constructor for class org.ejdb.bson.types.ObjectId +
Read ObjectId from string +
open(String) - +Method in class org.ejdb.driver.EJDB +
Open database using default open mode. +
open(String, int) - +Method in class org.ejdb.driver.EJDB +
Open database. +
optimizeIndexes(String) - +Method in class org.ejdb.driver.EJDBCollection +
Optimize indexes of all types for BSON field path +
or() - +Method in class org.ejdb.driver.EJDBQueryBuilder +
Add OR joined query restrictions. +
orderBy() - +Method in class org.ejdb.driver.EJDBQueryBuilder +
Resturs return sorting rules control object +
org.ejdb.bson - package org.ejdb.bson
 
org.ejdb.bson.io - package org.ejdb.bson.io
 
org.ejdb.bson.types - package org.ejdb.bson.types
 
org.ejdb.bson.util - package org.ejdb.bson.util
 
org.ejdb.driver - package org.ejdb.driver
 
OutputBuffer - Class in org.ejdb.bson.io
Utility class for serialize BSON object
OutputBuffer() - +Constructor for class org.ejdb.bson.io.OutputBuffer +
  +
+
+

+P

+
+
pull(String, Object) - +Method in class org.ejdb.driver.EJDBQueryBuilder +
Atomically removes all occurrences of value from field, if field is an array. +
pullAll(String, Object...) - +Method in class org.ejdb.driver.EJDBQueryBuilder +
Atomically performs set substraction of values for specified array field. +
pullAll(String, Collection<Object>) - +Method in class org.ejdb.driver.EJDBQueryBuilder +
Atomically performs set substraction of values for specified array field. +
put(String, Object) - +Method in class org.ejdb.bson.BSONObject +
Add new key->value to BSON object. +
put(String, Object) - +Method in class org.ejdb.driver.BSONQueryObject +
Add new key->value to BSON object. +
putAll(Map<String, Object>) - +Method in class org.ejdb.bson.BSONObject +
Adds key->value pair to BSON object from specified Map +
putAll(BSONObject) - +Method in class org.ejdb.bson.BSONObject +
Adds key->value pair to BSON object from other BSON object +
+
+

+R

+
+
read() - +Method in class org.ejdb.bson.io.InputBuffer +
Reads one byte from buffer +
readBytes(int) - +Method in class org.ejdb.bson.io.InputBuffer +
Reads bytes from buffer +
readInt() - +Method in class org.ejdb.bson.io.InputBuffer +
Reads 4 bytes from buffer as integer value +
readLong() - +Method in class org.ejdb.bson.io.InputBuffer +
Reads 8 bytes from buffer as long value +
readString() - +Method in class org.ejdb.bson.io.InputBuffer +
Reads c-string (null-terminated) from buffer +
readString(int) - +Method in class org.ejdb.bson.io.InputBuffer +
Reads c-string from buffer with specified length +
rebuildArrayIndex(String) - +Method in class org.ejdb.driver.EJDBCollection +
Rebuild index of Array type for BSON field path. +
rebuildIStringIndex(String) - +Method in class org.ejdb.driver.EJDBCollection +
Rebuild case insensitive String index for BSON field path. +
rebuildNumderIndex(String) - +Method in class org.ejdb.driver.EJDBCollection +
Rebuild index of Number type for BSON field path. +
rebuildStringIndex(String) - +Method in class org.ejdb.driver.EJDBCollection +
Rebuild index of String type for BSON field path. +
REGEX - +Static variable in class org.ejdb.bson.BSON +
  +
RegexFlag - Class in org.ejdb.bson.util
Util class for convert Java regex flags to BSON string and conversely
regexFlagsToString(int) - +Static method in class org.ejdb.bson.util.RegexFlag +
Convert Java regex flags to BSON string +
registerField(String, Object) - +Method in class org.ejdb.bson.BSONObject +
  +
registerRegexFlag(int, char, boolean) - +Static method in class org.ejdb.bson.util.RegexFlag +
Register flag conversation rules +
remove(String) - +Method in class org.ejdb.bson.BSONObject +
Removes field from Object +
remove(ObjectId) - +Method in class org.ejdb.driver.EJDBCollection +
Remove BSON object from collection by OID +
remove() - +Method in class org.ejdb.driver.EJDBResultSet +
+
rollbackTransaction() - +Method in class org.ejdb.driver.EJDBCollection +
Abort collection transaction. +
+
+

+S

+
+
save(BSONObject) - +Method in class org.ejdb.driver.EJDBCollection +
Save/update specified BSON object in the collection. +
save(List<BSONObject>) - +Method in class org.ejdb.driver.EJDBCollection +
Save/update specified BSON objects in the collection. +
set(String, Object) - +Method in class org.ejdb.driver.EJDBQueryBuilder +
Set specified fiels to value +

+ query.set(field1, value1).set(field2, value2); // -> { ..., $set : {field1 : value1, field2 : value2}} +

setFieldIncluded(String, boolean) - +Method in class org.ejdb.driver.EJDBQueryBuilder +
Sets fields to be included or exluded in resulting objects. +
setIndex(String, int) - +Method in class org.ejdb.driver.EJDBCollection +
  +
setMaxResults(int) - +Method in class org.ejdb.driver.EJDBQueryBuilder +
Sets max number of records in the result set. +
setOffset(int) - +Method in class org.ejdb.driver.EJDBQueryBuilder +
Sets number of skipped records in the result set. +
setPosition(int) - +Method in class org.ejdb.bson.io.OutputBuffer +
Sets position +
size() - +Method in class org.ejdb.bson.BSONObject +
Returns fields count +
strAnd(String[]) - +Method in class org.ejdb.driver.EJDBQueryBuilder.Constraint +
String tokens (or string array vals) matches all tokens in specified array. +
strAnd(Collection<String>) - +Method in class org.ejdb.driver.EJDBQueryBuilder.Constraint +
String tokens (or string array vals) matches all tokens in specified collection. +
STRING - +Static variable in class org.ejdb.bson.BSON +
  +
stringToRegexFlags(String) - +Static method in class org.ejdb.bson.util.RegexFlag +
Read Java regex flags from BSON string +
strOr(String[]) - +Method in class org.ejdb.driver.EJDBQueryBuilder.Constraint +
String tokens (or string array vals) matches any tokens in specified array. +
strOr(Collection<String>) - +Method in class org.ejdb.driver.EJDBQueryBuilder.Constraint +
String tokens (or string array vals) matches any tokens in specified collection. +
subBuffer(int) - +Method in class org.ejdb.bson.io.InputBuffer +
Get sub buffer with specified length +
sync() - +Method in class org.ejdb.driver.EJDB +
Synchronize entire EJDB database and all its collections with storage. +
sync() - +Method in class org.ejdb.driver.EJDBCollection +
Synchronize entire collection with storage. +
+
+

+T

+
+
toByteArray() - +Method in class org.ejdb.bson.types.ObjectId +
Export ObjectId to plain byte array +
toString() - +Method in class org.ejdb.bson.BSONObject +
+
toString() - +Method in class org.ejdb.bson.types.ObjectId +
+
toString() - +Method in class org.ejdb.driver.EJDB +
+
toString() - +Method in class org.ejdb.driver.EJDBCollection.Index +
+
toString() - +Method in class org.ejdb.driver.EJDBCollection.Options +
+
toString() - +Method in class org.ejdb.driver.EJDBCollection +
+
txControl(int) - +Method in class org.ejdb.driver.EJDBCollection +
  +
+
+

+U

+
+
update() - +Method in class org.ejdb.driver.EJDBQuery +
Executes update query +
update(OutputStream) - +Method in class org.ejdb.driver.EJDBQuery +
Executes update query +
updateMeta() - +Method in class org.ejdb.driver.EJDB +
Update description of EJDB database and its collections. +
updateMeta() - +Method in class org.ejdb.driver.EJDBCollection +
Update collection metainformation from storage +
upsert(String, Object) - +Method in class org.ejdb.driver.EJDBQueryBuilder +
Atomic upsert. +
+
+

+V

+
+
valueOf(String) - +Static method in enum org.ejdb.driver.EJDBCollection.IndexType +
Returns the enum constant of this type with the specified name. +
values() - +Static method in enum org.ejdb.driver.EJDBCollection.IndexType +
Returns an array containing the constants of this enum type, in +the order they are declared. +
+
+

+W

+
+
write(byte) - +Method in class org.ejdb.bson.io.OutputBuffer +
Writes single byte to buffer +
write(byte[]) - +Method in class org.ejdb.bson.io.OutputBuffer +
Writes byte array to buffer +
write(byte[], int, int) - +Method in class org.ejdb.bson.io.OutputBuffer +
Writes part of byte array to buffer +
writeDouble(double) - +Method in class org.ejdb.bson.io.OutputBuffer +
Writes double value to buffers as 8 bytes +
writeInt(int) - +Method in class org.ejdb.bson.io.OutputBuffer +
Writes integer value to buffer as 4 bytes +
writeIntAt(int, int) - +Method in class org.ejdb.bson.io.OutputBuffer +
Writes integer value (4 bytes) at specified position +
writeLong(long) - +Method in class org.ejdb.bson.io.OutputBuffer +
Writes long value to buffer as 8 bytes +
writeString(String) - +Method in class org.ejdb.bson.io.OutputBuffer +
Writes String to buffer as c-style string (null-terminated) +
+
+A B C D E F G H I J L N O P R S T U V W + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/index.html b/jejdb/doc/index.html new file mode 100644 index 0000000..becf466 --- /dev/null +++ b/jejdb/doc/index.html @@ -0,0 +1,40 @@ + + + + + + + +JEJDB Doc + + + + + + + + + + + +<H2> +Frame Alert</H2> + +<P> +This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. +<BR> +Link to<A HREF="overview-summary.html">Non-frame version.</A> + + + diff --git a/jejdb/doc/org/ejdb/bson/BSON.html b/jejdb/doc/org/ejdb/bson/BSON.html new file mode 100644 index 0000000..614f22b --- /dev/null +++ b/jejdb/doc/org/ejdb/bson/BSON.html @@ -0,0 +1,487 @@ + + + + + + + +BSON (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.ejdb.bson +
+Class BSON

+
+java.lang.Object
+  extended by org.ejdb.bson.BSON
+
+
+
+
public final class BSON
extends java.lang.Object
+ + +

+Util class for encode/decode BSON objects +

+ +

+

+
Version:
+
$Id$
+
Author:
+
Tyutyunkov Vyacheslav (tve@softmotions.com)
+
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static byteARRAY + +
+           
+static byteBINARY + +
+           
+static byteBOOLEAN + +
+           
+static byteDATE + +
+           
+static byteDOUBLE + +
+           
+static byteINT + +
+           
+static byteLONG + +
+           
+static byteNULL + +
+           
+static byteOBJECT + +
+           
+static byteOBJECT_ID + +
+           
+static byteREGEX + +
+           
+static byteSTRING + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static BSONObjectdecode(byte[] data) + +
+          Decode BSON object from plain byte array
+static byte[]encode(BSONObject obj) + +
+          Encode BSON object to plain byte array
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+NULL

+
+public static final byte NULL
+
+
+
See Also:
Constant Field Values
+
+
+ +

+INT

+
+public static final byte INT
+
+
+
See Also:
Constant Field Values
+
+
+ +

+LONG

+
+public static final byte LONG
+
+
+
See Also:
Constant Field Values
+
+
+ +

+DOUBLE

+
+public static final byte DOUBLE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+STRING

+
+public static final byte STRING
+
+
+
See Also:
Constant Field Values
+
+
+ +

+BOOLEAN

+
+public static final byte BOOLEAN
+
+
+
See Also:
Constant Field Values
+
+
+ +

+OBJECT_ID

+
+public static final byte OBJECT_ID
+
+
+
See Also:
Constant Field Values
+
+
+ +

+OBJECT

+
+public static final byte OBJECT
+
+
+
See Also:
Constant Field Values
+
+
+ +

+BINARY

+
+public static final byte BINARY
+
+
+
See Also:
Constant Field Values
+
+
+ +

+ARRAY

+
+public static final byte ARRAY
+
+
+
See Also:
Constant Field Values
+
+
+ +

+DATE

+
+public static final byte DATE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+REGEX

+
+public static final byte REGEX
+
+
+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Method Detail
+ +

+encode

+
+public static byte[] encode(BSONObject obj)
+
+
Encode BSON object to plain byte array +

+

+
+
+
+
+ +

+decode

+
+public static BSONObject decode(byte[] data)
+
+
Decode BSON object from plain byte array +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/bson/BSONException.html b/jejdb/doc/org/ejdb/bson/BSONException.html new file mode 100644 index 0000000..5f2d355 --- /dev/null +++ b/jejdb/doc/org/ejdb/bson/BSONException.html @@ -0,0 +1,290 @@ + + + + + + + +BSONException (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.ejdb.bson +
+Class BSONException

+
+java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by org.ejdb.bson.BSONException
+
+
+
All Implemented Interfaces:
java.io.Serializable
+
+
+
+
public class BSONException
extends java.lang.RuntimeException
+ + +

+

+
Version:
+
$Id$
+
Author:
+
Tyutyunkov Vyacheslav (tve@softmotions.com)
+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + + + + + + + + + + +
+Constructor Summary
BSONException() + +
+           
BSONException(java.lang.String message) + +
+           
BSONException(java.lang.String message, + java.lang.Throwable cause) + +
+           
BSONException(java.lang.Throwable cause) + +
+           
+  + + + + + + + +
+Method Summary
+ + + + + + + +
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+BSONException

+
+public BSONException()
+
+
+
+ +

+BSONException

+
+public BSONException(java.lang.String message)
+
+
+
+ +

+BSONException

+
+public BSONException(java.lang.String message,
+                     java.lang.Throwable cause)
+
+
+
+ +

+BSONException

+
+public BSONException(java.lang.Throwable cause)
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/bson/BSONObject.html b/jejdb/doc/org/ejdb/bson/BSONObject.html new file mode 100644 index 0000000..7b3eb43 --- /dev/null +++ b/jejdb/doc/org/ejdb/bson/BSONObject.html @@ -0,0 +1,759 @@ + + + + + + + +BSONObject (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.ejdb.bson +
+Class BSONObject

+
+java.lang.Object
+  extended by org.ejdb.bson.BSONObject
+
+
+
Direct Known Subclasses:
BSONQueryObject
+
+
+
+
public class BSONObject
extends java.lang.Object
+ + +

+BSON object. +

+ NOTE: + ID_KEY must be valid ObjectId (ObjectId instance or valid byte[] or String) +

+ +

+

+
Version:
+
$Id$
+
Author:
+
Tyutyunkov Vyacheslav (tve@softmotions.com)
+
+
+ +

+ + + + + + + + + + + + + + + + + + + +
+Field Summary
+protected  java.util.Map<java.lang.String,java.lang.Object>data + +
+           
+protected  java.util.List<java.lang.String>fields + +
+           
+static java.lang.StringID_KEY + +
+          ID-field name
+  + + + + + + + + + + + + + + + + + + + + + + +
+Constructor Summary
BSONObject() + +
+          Constructs new BSON object
BSONObject(BSONObject src) + +
+          Constructs new BSON object as copy of other BSON object.
BSONObject(java.util.Map<java.lang.String,java.lang.Object> data) + +
+          Constructs new BSON object and init data from specified Map.
BSONObject(ObjectId oid) + +
+          Constructs new BSON object with specified id
BSONObject(java.lang.String key, + java.lang.Object value) + +
+          Constructs new BSON object with initial data.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ BSONObjectappend(java.lang.String key, + java.lang.Object value) + +
+          The same as put(String, Object) but return this
+ voidclear() + +
+          Removes all fields
+ booleancontainsField(java.lang.String key) + +
+          Checks field contains in BSON object
+ booleanequals(java.lang.Object o) + +
+          
+ java.util.List<java.lang.String>fields() + +
+          Returns fields in adding order
+ java.lang.Objectget(java.lang.String key) + +
+          Returns value of specified field if exists, or null otherwise
+ ObjectIdgetId() + +
+          Returns id of BSON object (if specified)
+ inthashCode() + +
+          
+protected  booleanisFieldsOrderImportant() + +
+          If returns true fields order will be checks on equal.
+ java.lang.Objectput(java.lang.String key, + java.lang.Object value) + +
+          Add new key->value to BSON object.
+ voidputAll(BSONObject object) + +
+          Adds key->value pair to BSON object from other BSON object
+ voidputAll(java.util.Map<java.lang.String,java.lang.Object> values) + +
+          Adds key->value pair to BSON object from specified Map
+protected  java.lang.ObjectregisterField(java.lang.String key, + java.lang.Object value) + +
+           
+ voidremove(java.lang.String field) + +
+          Removes field from Object
+ intsize() + +
+          Returns fields count
+ java.lang.StringtoString() + +
+          
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+ID_KEY

+
+public static final java.lang.String ID_KEY
+
+
ID-field name +

+

+
See Also:
Constant Field Values
+
+
+ +

+data

+
+protected java.util.Map<java.lang.String,java.lang.Object> data
+
+
+
+
+
+ +

+fields

+
+protected java.util.List<java.lang.String> fields
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+BSONObject

+
+public BSONObject()
+
+
Constructs new BSON object +

+

+
+ +

+BSONObject

+
+public BSONObject(ObjectId oid)
+
+
Constructs new BSON object with specified id +

+

+
+ +

+BSONObject

+
+public BSONObject(java.lang.String key,
+                  java.lang.Object value)
+
+
Constructs new BSON object with initial data. + The same as: + + BSONObject obj = new BSONObject(); + obj.put(key, value); + +

+

+
+ +

+BSONObject

+
+public BSONObject(java.util.Map<java.lang.String,java.lang.Object> data)
+
+
Constructs new BSON object and init data from specified Map. + The same as + + BSONObject obj = new BSONObject(); + obj.putAll(data); + +

+

+
+ +

+BSONObject

+
+public BSONObject(BSONObject src)
+
+
Constructs new BSON object as copy of other BSON object. +

+

+ + + + + + + + +
+Method Detail
+ +

+registerField

+
+protected java.lang.Object registerField(java.lang.String key,
+                                         java.lang.Object value)
+
+
+
+
+
+
+ +

+put

+
+public java.lang.Object put(java.lang.String key,
+                            java.lang.Object value)
+                     throws java.lang.IllegalArgumentException
+
+
Add new key->value to BSON object. +

+

+ +
Returns:
added value +
Throws: +
java.lang.IllegalArgumentException - if not valid ObjectId data passed as _id (ID_KEY field.
+
+
+
+ +

+append

+
+public BSONObject append(java.lang.String key,
+                         java.lang.Object value)
+
+
The same as put(String, Object) but return this +

+

+
+
+
+
+ +

+putAll

+
+public void putAll(java.util.Map<java.lang.String,java.lang.Object> values)
+
+
Adds key->value pair to BSON object from specified Map +

+

+
+
+
+
+ +

+putAll

+
+public void putAll(BSONObject object)
+
+
Adds key->value pair to BSON object from other BSON object +

+

+
+
+
+
+ +

+fields

+
+public java.util.List<java.lang.String> fields()
+
+
Returns fields in adding order +

+

+ +
Returns:
fields in adding order
+
+
+
+ +

+getId

+
+public ObjectId getId()
+
+
Returns id of BSON object (if specified) +

+

+ +
Returns:
id of BSON object (if specified)
+
+
+
+ +

+get

+
+public java.lang.Object get(java.lang.String key)
+
+
Returns value of specified field if exists, or null otherwise +

+

+ +
Returns:
value of specified field if exists, or null otherwise
+
+
+
+ +

+size

+
+public int size()
+
+
Returns fields count +

+

+ +
Returns:
fields count
+
+
+
+ +

+containsField

+
+public boolean containsField(java.lang.String key)
+
+
Checks field contains in BSON object +

+

+
+
+
+
+ +

+remove

+
+public void remove(java.lang.String field)
+
+
Removes field from Object +

+

+
+
+
+
+ +

+clear

+
+public void clear()
+
+
Removes all fields +

+

+
+
+
+
+ +

+isFieldsOrderImportant

+
+protected boolean isFieldsOrderImportant()
+
+
If returns true fields order will be checks on equal. +

+

+
+
+
+
+ +

+equals

+
+public boolean equals(java.lang.Object o)
+
+
+

+

+
Overrides:
equals in class java.lang.Object
+
+
+
+
+
+
+ +

+hashCode

+
+public int hashCode()
+
+
+

+

+
Overrides:
hashCode in class java.lang.Object
+
+
+
+
+
+
+ +

+toString

+
+public java.lang.String toString()
+
+
+

+

+
Overrides:
toString in class java.lang.Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/bson/class-use/BSON.html b/jejdb/doc/org/ejdb/bson/class-use/BSON.html new file mode 100644 index 0000000..f566749 --- /dev/null +++ b/jejdb/doc/org/ejdb/bson/class-use/BSON.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.ejdb.bson.BSON (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
org.ejdb.bson.BSON

+
+No usage of org.ejdb.bson.BSON +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/bson/class-use/BSONException.html b/jejdb/doc/org/ejdb/bson/class-use/BSONException.html new file mode 100644 index 0000000..9246091 --- /dev/null +++ b/jejdb/doc/org/ejdb/bson/class-use/BSONException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.ejdb.bson.BSONException (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
org.ejdb.bson.BSONException

+
+No usage of org.ejdb.bson.BSONException +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/bson/class-use/BSONObject.html b/jejdb/doc/org/ejdb/bson/class-use/BSONObject.html new file mode 100644 index 0000000..6372848 --- /dev/null +++ b/jejdb/doc/org/ejdb/bson/class-use/BSONObject.html @@ -0,0 +1,527 @@ + + + + + + + +Uses of Class org.ejdb.bson.BSONObject (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
org.ejdb.bson.BSONObject

+
+ + + + + + + + + + + + + +
+Packages that use BSONObject
org.ejdb.bson  
org.ejdb.driver  
+  +

+ + + + + +
+Uses of BSONObject in org.ejdb.bson
+  +

+ + + + + + + + + + + + + +
Methods in org.ejdb.bson that return BSONObject
+ BSONObjectBSONObject.append(java.lang.String key, + java.lang.Object value) + +
+          The same as put(String, Object) but return this
+static BSONObjectBSON.decode(byte[] data) + +
+          Decode BSON object from plain byte array
+  +

+ + + + + + + + + + + + + +
Methods in org.ejdb.bson with parameters of type BSONObject
+static byte[]BSON.encode(BSONObject obj) + +
+          Encode BSON object to plain byte array
+ voidBSONObject.putAll(BSONObject object) + +
+          Adds key->value pair to BSON object from other BSON object
+  +

+ + + + + + + + +
Constructors in org.ejdb.bson with parameters of type BSONObject
BSONObject(BSONObject src) + +
+          Constructs new BSON object as copy of other BSON object.
+  +

+ + + + + +
+Uses of BSONObject in org.ejdb.driver
+  +

+ + + + + + + + + +
Subclasses of BSONObject in org.ejdb.driver
+ classBSONQueryObject + +
+          BSON object for EJDB queries (limitation checks for ID_KEY field)
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in org.ejdb.driver that return BSONObject
+ BSONObjectEJDBQuery.findOne() + +
+          Same as EJDBQuery.find() but retrieves only one matching JSON object.
+ BSONObjectEJDBQuery.findOne(java.io.OutputStream log) + +
+          Same as EJDBQuery.find() but retrieves only one matching JSON object.
+ BSONObjectEJDBResultSet.get(int position) + +
+          Returns object by position
+ BSONObjectEJDBQueryBuilder.getMainQuery() + +
+          Returns main BSON query object
+ BSONObject[]EJDBQueryBuilder.getOrQueries() + +
+          Returns BSON objects for additional OR queries
+ BSONObjectEJDBQueryBuilder.getQueryHints() + +
+          Returns BSON hints object
+ BSONObjectEJDBCollection.load(ObjectId oid) + +
+          Loads BSON object identified by OID from the collection.
+ BSONObjectEJDBResultSet.next() + +
+          
+  +

+ + + + + + + + + +
Methods in org.ejdb.driver that return types with arguments of type BSONObject
+ java.util.Iterator<BSONObject>EJDBResultSet.iterator() + +
+          
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in org.ejdb.driver with parameters of type BSONObject
+protected  voidEJDBQueryBuilder.addToBSON(BSONObject out, + java.lang.String field, + java.lang.Object value) + +
+           
+ EJDBQueryEJDBCollection.createQuery(BSONObject query) + +
+          Deprecated.  
+ EJDBQueryEJDBCollection.createQuery(BSONObject query, + BSONObject hints) + +
+          Deprecated.  
+ EJDBQueryEJDBCollection.createQuery(BSONObject query, + BSONObject[] qors) + +
+          Deprecated.  
+ EJDBQueryEJDBCollection.createQuery(BSONObject query, + BSONObject[] qors) + +
+          Deprecated.  
+ EJDBQueryEJDBCollection.createQuery(BSONObject query, + BSONObject[] qors, + BSONObject hints) + +
+          Deprecated.  
+ EJDBQueryEJDBCollection.createQuery(BSONObject query, + BSONObject[] qors, + BSONObject hints) + +
+          Deprecated.  
+protected  org.ejdb.driver.EJDBQuery.QResultEJDBQuery.execute(BSONObject query, + BSONObject[] qors, + BSONObject hints, + int flags, + java.io.OutputStream log) + +
+           
+protected  org.ejdb.driver.EJDBQuery.QResultEJDBQuery.execute(BSONObject query, + BSONObject[] qors, + BSONObject hints, + int flags, + java.io.OutputStream log) + +
+           
+protected  org.ejdb.driver.EJDBQuery.QResultEJDBQuery.execute(BSONObject hints, + int flags, + java.io.OutputStream log) + +
+           
+ ObjectIdEJDBCollection.save(BSONObject object) + +
+          Save/update specified BSON object in the collection.
+  +

+ + + + + + + + + +
Method parameters in org.ejdb.driver with type arguments of type BSONObject
+ java.util.List<ObjectId>EJDBCollection.save(java.util.List<BSONObject> objects) + +
+          Save/update specified BSON objects in the collection.
+  +

+ + + + + + + + + + + + + + + + + +
Constructors in org.ejdb.driver with parameters of type BSONObject
BSONQueryObject(BSONObject src) + +
+           
EJDBQueryBuilder.OrderBy(BSONObject orderBy) + +
+           
EJDBQueryBuilder(BSONObject query, + java.util.List<BSONObject> queryOrs, + BSONObject hints) + +
+           
EJDBQueryBuilder(EJDBQueryBuilder parent, + BSONObject query) + +
+           
+  +

+ + + + + + + + +
Constructor parameters in org.ejdb.driver with type arguments of type BSONObject
EJDBQueryBuilder(BSONObject query, + java.util.List<BSONObject> queryOrs, + BSONObject hints) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/bson/io/InputBuffer.html b/jejdb/doc/org/ejdb/bson/io/InputBuffer.html new file mode 100644 index 0000000..572e420 --- /dev/null +++ b/jejdb/doc/org/ejdb/bson/io/InputBuffer.html @@ -0,0 +1,422 @@ + + + + + + + +InputBuffer (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.ejdb.bson.io +
+Class InputBuffer

+
+java.lang.Object
+  extended by org.ejdb.bson.io.InputBuffer
+
+
+
+
public class InputBuffer
extends java.lang.Object
+ + +

+Utility class for reading BSON object data from byte array +

+ +

+

+
Version:
+
$Id$
+
Author:
+
Tyutyunkov Vyacheslav (tve@softmotions.com)
+
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static InputBuffercreateFromByteArray(byte[] data) + +
+          Creates InputBuffer from byte array
+protected  voidensure(int size) + +
+          Checks is buffer contains needed bytes
+ booleanisAvailable() + +
+          Returns true if any bytes available to read from buffer or false otherwise
+ byteread() + +
+          Reads one byte from buffer
+ byte[]readBytes(int count) + +
+          Reads bytes from buffer
+ intreadInt() + +
+          Reads 4 bytes from buffer as integer value
+ longreadLong() + +
+          Reads 8 bytes from buffer as long value
+ java.lang.StringreadString() + +
+          Reads c-string (null-terminated) from buffer
+ java.lang.StringreadString(int length) + +
+          Reads c-string from buffer with specified length
+ InputBuffersubBuffer(int limit) + +
+          Get sub buffer with specified length
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Method Detail
+ +

+read

+
+public byte read()
+
+
Reads one byte from buffer +

+

+
+
+
+
+ +

+readInt

+
+public int readInt()
+
+
Reads 4 bytes from buffer as integer value +

+

+
+
+
+
+ +

+readLong

+
+public long readLong()
+
+
Reads 8 bytes from buffer as long value +

+

+
+
+
+
+ +

+readBytes

+
+public byte[] readBytes(int count)
+
+
Reads bytes from buffer +

+

+
Parameters:
count - count of bytes to read
+
+
+
+ +

+readString

+
+public java.lang.String readString()
+
+
Reads c-string (null-terminated) from buffer +

+

+
+
+
+
+ +

+readString

+
+public java.lang.String readString(int length)
+
+
Reads c-string from buffer with specified length +

+

+
+
+
+
+ +

+isAvailable

+
+public boolean isAvailable()
+
+
Returns true if any bytes available to read from buffer or false otherwise +

+

+ +
Returns:
true if any bytes available to read from buffer or false otherwise
+
+
+
+ +

+subBuffer

+
+public InputBuffer subBuffer(int limit)
+
+
Get sub buffer with specified length +

+

+
+
+
+
+ +

+ensure

+
+protected void ensure(int size)
+
+
Checks is buffer contains needed bytes +

+

+
+
+
+
+ +

+createFromByteArray

+
+public static InputBuffer createFromByteArray(byte[] data)
+
+
Creates InputBuffer from byte array +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/bson/io/OutputBuffer.html b/jejdb/doc/org/ejdb/bson/io/OutputBuffer.html new file mode 100644 index 0000000..2d718a7 --- /dev/null +++ b/jejdb/doc/org/ejdb/bson/io/OutputBuffer.html @@ -0,0 +1,563 @@ + + + + + + + +OutputBuffer (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.ejdb.bson.io +
+Class OutputBuffer

+
+java.lang.Object
+  extended by org.ejdb.bson.io.OutputBuffer
+
+
+
+
public class OutputBuffer
extends java.lang.Object
+ + +

+Utility class for serialize BSON object +

+ +

+

+
Version:
+
$Id$
+
Author:
+
Tyutyunkov Vyacheslav (tve@softmotions.com)
+
+
+ +

+ + + + + + + + + + + +
+Field Summary
+static intBUFFER_DEFAULT_LENGTH + +
+           
+  + + + + + + + + + + +
+Constructor Summary
OutputBuffer() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+protected  voidensureLength(int need) + +
+          Checks internal array size to hold needed data and expand it if need.
+ intgetActualSize() + +
+          Returns actual (full) size of buffer (currently writed bytes)
+ intgetPosition() + +
+          Returns current position in output
+ byte[]getResult() + +
+          Returns buffer as byte array
+ voidsetPosition(int position) + +
+          Sets position
+ voidwrite(byte data) + +
+          Writes single byte to buffer
+ voidwrite(byte[] data) + +
+          Writes byte array to buffer
+ voidwrite(byte[] data, + int offset, + int length) + +
+          Writes part of byte array to buffer
+ voidwriteDouble(double value) + +
+          Writes double value to buffers as 8 bytes
+ voidwriteInt(int value) + +
+          Writes integer value to buffer as 4 bytes
+ voidwriteIntAt(int position, + int value) + +
+          Writes integer value (4 bytes) at specified position
+ voidwriteLong(long value) + +
+          Writes long value to buffer as 8 bytes
+ intwriteString(java.lang.String value) + +
+          Writes String to buffer as c-style string (null-terminated)
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+BUFFER_DEFAULT_LENGTH

+
+public static final int BUFFER_DEFAULT_LENGTH
+
+
+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+OutputBuffer

+
+public OutputBuffer()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getPosition

+
+public int getPosition()
+
+
Returns current position in output +

+

+ +
Returns:
current position in output
+
+
+
+ +

+setPosition

+
+public void setPosition(int position)
+
+
Sets position +

+

+
+
+
+
+ +

+getActualSize

+
+public int getActualSize()
+
+
Returns actual (full) size of buffer (currently writed bytes) +

+

+ +
Returns:
actual (full) size of buffer (currently writed bytes)
+
+
+
+ +

+getResult

+
+public byte[] getResult()
+
+
Returns buffer as byte array +

+

+ +
Returns:
buffer as byte array
+
+
+
+ +

+write

+
+public void write(byte data)
+
+
Writes single byte to buffer +

+

+
+
+
+
+ +

+write

+
+public void write(byte[] data)
+
+
Writes byte array to buffer +

+

+
+
+
+
+ +

+write

+
+public void write(byte[] data,
+                  int offset,
+                  int length)
+
+
Writes part of byte array to buffer +

+

+
Parameters:
data - source byte array
offset - start position in source
length - count bytes to write
+
+
+
+ +

+writeIntAt

+
+public void writeIntAt(int position,
+                       int value)
+
+
Writes integer value (4 bytes) at specified position +

+

+
Parameters:
position - position to write
value - value
+
+
+
+ +

+writeInt

+
+public void writeInt(int value)
+
+
Writes integer value to buffer as 4 bytes +

+

+
+
+
+
+ +

+writeLong

+
+public void writeLong(long value)
+
+
Writes long value to buffer as 8 bytes +

+

+
+
+
+
+ +

+writeDouble

+
+public void writeDouble(double value)
+
+
Writes double value to buffers as 8 bytes +

+

+
+
+
+
+ +

+writeString

+
+public int writeString(java.lang.String value)
+
+
Writes String to buffer as c-style string (null-terminated) +

+

+ +
Returns:
count of writed bytes
+
+
+
+ +

+ensureLength

+
+protected void ensureLength(int need)
+
+
Checks internal array size to hold needed data and expand it if need. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/bson/io/class-use/InputBuffer.html b/jejdb/doc/org/ejdb/bson/io/class-use/InputBuffer.html new file mode 100644 index 0000000..32bf0aa --- /dev/null +++ b/jejdb/doc/org/ejdb/bson/io/class-use/InputBuffer.html @@ -0,0 +1,189 @@ + + + + + + + +Uses of Class org.ejdb.bson.io.InputBuffer (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
org.ejdb.bson.io.InputBuffer

+
+ + + + + + + + + +
+Packages that use InputBuffer
org.ejdb.bson.io  
+  +

+ + + + + +
+Uses of InputBuffer in org.ejdb.bson.io
+  +

+ + + + + + + + + + + + + +
Methods in org.ejdb.bson.io that return InputBuffer
+static InputBufferInputBuffer.createFromByteArray(byte[] data) + +
+          Creates InputBuffer from byte array
+ InputBufferInputBuffer.subBuffer(int limit) + +
+          Get sub buffer with specified length
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/bson/io/class-use/OutputBuffer.html b/jejdb/doc/org/ejdb/bson/io/class-use/OutputBuffer.html new file mode 100644 index 0000000..720f299 --- /dev/null +++ b/jejdb/doc/org/ejdb/bson/io/class-use/OutputBuffer.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.ejdb.bson.io.OutputBuffer (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
org.ejdb.bson.io.OutputBuffer

+
+No usage of org.ejdb.bson.io.OutputBuffer +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/bson/io/package-frame.html b/jejdb/doc/org/ejdb/bson/io/package-frame.html new file mode 100644 index 0000000..de1ac1e --- /dev/null +++ b/jejdb/doc/org/ejdb/bson/io/package-frame.html @@ -0,0 +1,35 @@ + + + + + + + +org.ejdb.bson.io (JEJDB Doc) + + + + + + + + + + + +org.ejdb.bson.io + + + + +
+Classes  + +
+InputBuffer +
+OutputBuffer
+ + + + diff --git a/jejdb/doc/org/ejdb/bson/io/package-summary.html b/jejdb/doc/org/ejdb/bson/io/package-summary.html new file mode 100644 index 0000000..5f148f9 --- /dev/null +++ b/jejdb/doc/org/ejdb/bson/io/package-summary.html @@ -0,0 +1,162 @@ + + + + + + + +org.ejdb.bson.io (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package org.ejdb.bson.io +

+ + + + + + + + + + + + + +
+Class Summary
InputBufferUtility class for reading BSON object data from byte array
OutputBufferUtility class for serialize BSON object
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/bson/io/package-tree.html b/jejdb/doc/org/ejdb/bson/io/package-tree.html new file mode 100644 index 0000000..44d62cc --- /dev/null +++ b/jejdb/doc/org/ejdb/bson/io/package-tree.html @@ -0,0 +1,154 @@ + + + + + + + +org.ejdb.bson.io Class Hierarchy (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package org.ejdb.bson.io +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/bson/io/package-use.html b/jejdb/doc/org/ejdb/bson/io/package-use.html new file mode 100644 index 0000000..f2fff0e --- /dev/null +++ b/jejdb/doc/org/ejdb/bson/io/package-use.html @@ -0,0 +1,171 @@ + + + + + + + +Uses of Package org.ejdb.bson.io (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
org.ejdb.bson.io

+
+ + + + + + + + + +
+Packages that use org.ejdb.bson.io
org.ejdb.bson.io  
+  +

+ + + + + + + + +
+Classes in org.ejdb.bson.io used by org.ejdb.bson.io
InputBuffer + +
+          Utility class for reading BSON object data from byte array
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/bson/package-frame.html b/jejdb/doc/org/ejdb/bson/package-frame.html new file mode 100644 index 0000000..fa574e7 --- /dev/null +++ b/jejdb/doc/org/ejdb/bson/package-frame.html @@ -0,0 +1,46 @@ + + + + + + + +org.ejdb.bson (JEJDB Doc) + + + + + + + + + + + +org.ejdb.bson + + + + +
+Classes  + +
+BSON +
+BSONObject
+ + + + + + +
+Exceptions  + +
+BSONException
+ + + + diff --git a/jejdb/doc/org/ejdb/bson/package-summary.html b/jejdb/doc/org/ejdb/bson/package-summary.html new file mode 100644 index 0000000..1213fe1 --- /dev/null +++ b/jejdb/doc/org/ejdb/bson/package-summary.html @@ -0,0 +1,176 @@ + + + + + + + +org.ejdb.bson (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package org.ejdb.bson +

+ + + + + + + + + + + + + +
+Class Summary
BSONUtil class for encode/decode BSON objects
BSONObjectBSON object.
+  + +

+ + + + + + + + + +
+Exception Summary
BSONException 
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/bson/package-tree.html b/jejdb/doc/org/ejdb/bson/package-tree.html new file mode 100644 index 0000000..6bc7fce --- /dev/null +++ b/jejdb/doc/org/ejdb/bson/package-tree.html @@ -0,0 +1,161 @@ + + + + + + + +org.ejdb.bson Class Hierarchy (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package org.ejdb.bson +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+
    +
  • java.lang.Object
      +
    • org.ejdb.bson.BSON
    • org.ejdb.bson.BSONObject
    • java.lang.Throwable (implements java.io.Serializable) +
        +
      • java.lang.Exception +
      +
    +
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/bson/package-use.html b/jejdb/doc/org/ejdb/bson/package-use.html new file mode 100644 index 0000000..b035af8 --- /dev/null +++ b/jejdb/doc/org/ejdb/bson/package-use.html @@ -0,0 +1,190 @@ + + + + + + + +Uses of Package org.ejdb.bson (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
org.ejdb.bson

+
+ + + + + + + + + + + + + +
+Packages that use org.ejdb.bson
org.ejdb.bson  
org.ejdb.driver  
+  +

+ + + + + + + + +
+Classes in org.ejdb.bson used by org.ejdb.bson
BSONObject + +
+          BSON object.
+  +

+ + + + + + + + +
+Classes in org.ejdb.bson used by org.ejdb.driver
BSONObject + +
+          BSON object.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/bson/types/ObjectId.html b/jejdb/doc/org/ejdb/bson/types/ObjectId.html new file mode 100644 index 0000000..678873f --- /dev/null +++ b/jejdb/doc/org/ejdb/bson/types/ObjectId.html @@ -0,0 +1,386 @@ + + + + + + + +ObjectId (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.ejdb.bson.types +
+Class ObjectId

+
+java.lang.Object
+  extended by org.ejdb.bson.types.ObjectId
+
+
+
+
public class ObjectId
extends java.lang.Object
+ + +

+BSON Object ID +

+ +

+

+
Version:
+
$Id$
+
Author:
+
Tyutyunkov Vyacheslav (tve@softmotions.com)
+
+
+ +

+ + + + + + + + + + + + + + +
+Constructor Summary
ObjectId(byte[] data) + +
+          Read ObjectId from byte array
ObjectId(java.lang.String value) + +
+          Read ObjectId from string
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ booleanequals(java.lang.Object o) + +
+          
+ inthashCode() + +
+          
+static booleanisValid(java.lang.String value) + +
+          Checks string on valid ObjectId data
+ byte[]toByteArray() + +
+          Export ObjectId to plain byte array
+ java.lang.StringtoString() + +
+          
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ObjectId

+
+public ObjectId(byte[] data)
+         throws java.lang.IllegalArgumentException
+
+
Read ObjectId from byte array +

+

+ +
Throws: +
java.lang.IllegalStateException - if not valid ObjectId data passed +
java.lang.IllegalArgumentException
+
+
+ +

+ObjectId

+
+public ObjectId(java.lang.String value)
+
+
Read ObjectId from string +

+

+ +
Throws: +
java.lang.IllegalStateException - if not valid ObjectId data passed
+
+ + + + + + + + +
+Method Detail
+ +

+toByteArray

+
+public byte[] toByteArray()
+
+
Export ObjectId to plain byte array +

+

+
+
+
+
+ +

+equals

+
+public boolean equals(java.lang.Object o)
+
+
+

+

+
Overrides:
equals in class java.lang.Object
+
+
+
+
+
+
+ +

+hashCode

+
+public int hashCode()
+
+
+

+

+
Overrides:
hashCode in class java.lang.Object
+
+
+
+
+
+
+ +

+toString

+
+public java.lang.String toString()
+
+
+

+

+
Overrides:
toString in class java.lang.Object
+
+
+
+
+
+
+ +

+isValid

+
+public static boolean isValid(java.lang.String value)
+
+
Checks string on valid ObjectId data +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/bson/types/class-use/ObjectId.html b/jejdb/doc/org/ejdb/bson/types/class-use/ObjectId.html new file mode 100644 index 0000000..779d256 --- /dev/null +++ b/jejdb/doc/org/ejdb/bson/types/class-use/ObjectId.html @@ -0,0 +1,272 @@ + + + + + + + +Uses of Class org.ejdb.bson.types.ObjectId (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
org.ejdb.bson.types.ObjectId

+
+ + + + + + + + + + + + + +
+Packages that use ObjectId
org.ejdb.bson  
org.ejdb.driver  
+  +

+ + + + + +
+Uses of ObjectId in org.ejdb.bson
+  +

+ + + + + + + + + +
Methods in org.ejdb.bson that return ObjectId
+ ObjectIdBSONObject.getId() + +
+          Returns id of BSON object (if specified)
+  +

+ + + + + + + + +
Constructors in org.ejdb.bson with parameters of type ObjectId
BSONObject(ObjectId oid) + +
+          Constructs new BSON object with specified id
+  +

+ + + + + +
+Uses of ObjectId in org.ejdb.driver
+  +

+ + + + + + + + + + + + + +
Methods in org.ejdb.driver that return ObjectId
+ ObjectIdBSONQueryObject.getId() + +
+          Deprecated. BSON Query objects can not contains dedicated ObjectID
+ ObjectIdEJDBCollection.save(BSONObject object) + +
+          Save/update specified BSON object in the collection.
+  +

+ + + + + + + + + +
Methods in org.ejdb.driver that return types with arguments of type ObjectId
+ java.util.List<ObjectId>EJDBCollection.save(java.util.List<BSONObject> objects) + +
+          Save/update specified BSON objects in the collection.
+  +

+ + + + + + + + + + + + + +
Methods in org.ejdb.driver with parameters of type ObjectId
+ BSONObjectEJDBCollection.load(ObjectId oid) + +
+          Loads BSON object identified by OID from the collection.
+ voidEJDBCollection.remove(ObjectId oid) + +
+          Remove BSON object from collection by OID
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/bson/types/package-frame.html b/jejdb/doc/org/ejdb/bson/types/package-frame.html new file mode 100644 index 0000000..6373b65 --- /dev/null +++ b/jejdb/doc/org/ejdb/bson/types/package-frame.html @@ -0,0 +1,33 @@ + + + + + + + +org.ejdb.bson.types (JEJDB Doc) + + + + + + + + + + + +org.ejdb.bson.types + + + + +
+Classes  + +
+ObjectId
+ + + + diff --git a/jejdb/doc/org/ejdb/bson/types/package-summary.html b/jejdb/doc/org/ejdb/bson/types/package-summary.html new file mode 100644 index 0000000..b3e4c80 --- /dev/null +++ b/jejdb/doc/org/ejdb/bson/types/package-summary.html @@ -0,0 +1,158 @@ + + + + + + + +org.ejdb.bson.types (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package org.ejdb.bson.types +

+ + + + + + + + + +
+Class Summary
ObjectIdBSON Object ID
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/bson/types/package-tree.html b/jejdb/doc/org/ejdb/bson/types/package-tree.html new file mode 100644 index 0000000..3731fb9 --- /dev/null +++ b/jejdb/doc/org/ejdb/bson/types/package-tree.html @@ -0,0 +1,154 @@ + + + + + + + +org.ejdb.bson.types Class Hierarchy (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package org.ejdb.bson.types +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+
    +
  • java.lang.Object +
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/bson/types/package-use.html b/jejdb/doc/org/ejdb/bson/types/package-use.html new file mode 100644 index 0000000..9c02175 --- /dev/null +++ b/jejdb/doc/org/ejdb/bson/types/package-use.html @@ -0,0 +1,190 @@ + + + + + + + +Uses of Package org.ejdb.bson.types (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
org.ejdb.bson.types

+
+ + + + + + + + + + + + + +
+Packages that use org.ejdb.bson.types
org.ejdb.bson  
org.ejdb.driver  
+  +

+ + + + + + + + +
+Classes in org.ejdb.bson.types used by org.ejdb.bson
ObjectId + +
+          BSON Object ID
+  +

+ + + + + + + + +
+Classes in org.ejdb.bson.types used by org.ejdb.driver
ObjectId + +
+          BSON Object ID
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/bson/util/RegexFlag.html b/jejdb/doc/org/ejdb/bson/util/RegexFlag.html new file mode 100644 index 0000000..a540b75 --- /dev/null +++ b/jejdb/doc/org/ejdb/bson/util/RegexFlag.html @@ -0,0 +1,344 @@ + + + + + + + +RegexFlag (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.ejdb.bson.util +
+Class RegexFlag

+
+java.lang.Object
+  extended by org.ejdb.bson.util.RegexFlag
+
+
+
+
public final class RegexFlag
extends java.lang.Object
+ + +

+Util class for convert Java regex flags to BSON string and conversely +

+ +

+

+
Version:
+
$Id$
+
Author:
+
Tyutyunkov Vyacheslav (tve@softmotions.com)
+
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ chargetCharacter() + +
+          Returns BSON character for associated Java regex flag
+ intgetFlag() + +
+          Returns Java flag
+ booleanisSupported() + +
+          Returns true if BSON supported current Java flag
+static java.lang.StringregexFlagsToString(int flags) + +
+          Convert Java regex flags to BSON string
+protected static voidregisterRegexFlag(int flag, + char character, + boolean supported) + +
+          Register flag conversation rules
+static intstringToRegexFlags(java.lang.String str) + +
+          Read Java regex flags from BSON string
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Method Detail
+ +

+regexFlagsToString

+
+public static java.lang.String regexFlagsToString(int flags)
+
+
Convert Java regex flags to BSON string +

+

+
+
+
+
+ +

+stringToRegexFlags

+
+public static int stringToRegexFlags(java.lang.String str)
+
+
Read Java regex flags from BSON string +

+

+
+
+
+
+ +

+registerRegexFlag

+
+protected static void registerRegexFlag(int flag,
+                                        char character,
+                                        boolean supported)
+
+
Register flag conversation rules +

+

+
+
+
+
+ +

+getFlag

+
+public int getFlag()
+
+
Returns Java flag +

+

+ +
Returns:
Java flag
+
+
+
+ +

+getCharacter

+
+public char getCharacter()
+
+
Returns BSON character for associated Java regex flag +

+

+ +
Returns:
BSON character for associated Java regex flag
+
+
+
+ +

+isSupported

+
+public boolean isSupported()
+
+
Returns true if BSON supported current Java flag +

+

+ +
Returns:
true if BSON supported current Java flag
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/bson/util/class-use/RegexFlag.html b/jejdb/doc/org/ejdb/bson/util/class-use/RegexFlag.html new file mode 100644 index 0000000..1e01692 --- /dev/null +++ b/jejdb/doc/org/ejdb/bson/util/class-use/RegexFlag.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.ejdb.bson.util.RegexFlag (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
org.ejdb.bson.util.RegexFlag

+
+No usage of org.ejdb.bson.util.RegexFlag +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/bson/util/package-frame.html b/jejdb/doc/org/ejdb/bson/util/package-frame.html new file mode 100644 index 0000000..e698661 --- /dev/null +++ b/jejdb/doc/org/ejdb/bson/util/package-frame.html @@ -0,0 +1,33 @@ + + + + + + + +org.ejdb.bson.util (JEJDB Doc) + + + + + + + + + + + +org.ejdb.bson.util + + + + +
+Classes  + +
+RegexFlag
+ + + + diff --git a/jejdb/doc/org/ejdb/bson/util/package-summary.html b/jejdb/doc/org/ejdb/bson/util/package-summary.html new file mode 100644 index 0000000..daf09ba --- /dev/null +++ b/jejdb/doc/org/ejdb/bson/util/package-summary.html @@ -0,0 +1,158 @@ + + + + + + + +org.ejdb.bson.util (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package org.ejdb.bson.util +

+ + + + + + + + + +
+Class Summary
RegexFlagUtil class for convert Java regex flags to BSON string and conversely
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/bson/util/package-tree.html b/jejdb/doc/org/ejdb/bson/util/package-tree.html new file mode 100644 index 0000000..5c59f71 --- /dev/null +++ b/jejdb/doc/org/ejdb/bson/util/package-tree.html @@ -0,0 +1,154 @@ + + + + + + + +org.ejdb.bson.util Class Hierarchy (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package org.ejdb.bson.util +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+
    +
  • java.lang.Object +
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/bson/util/package-use.html b/jejdb/doc/org/ejdb/bson/util/package-use.html new file mode 100644 index 0000000..51efd49 --- /dev/null +++ b/jejdb/doc/org/ejdb/bson/util/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package org.ejdb.bson.util (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
org.ejdb.bson.util

+
+No usage of org.ejdb.bson.util +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/driver/BSONQueryObject.html b/jejdb/doc/org/ejdb/driver/BSONQueryObject.html new file mode 100644 index 0000000..af1beb7 --- /dev/null +++ b/jejdb/doc/org/ejdb/driver/BSONQueryObject.html @@ -0,0 +1,421 @@ + + + + + + + +BSONQueryObject (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.ejdb.driver +
+Class BSONQueryObject

+
+java.lang.Object
+  extended by org.ejdb.bson.BSONObject
+      extended by org.ejdb.driver.BSONQueryObject
+
+
+
+
public class BSONQueryObject
extends BSONObject
+ + +

+BSON object for EJDB queries (limitation checks for BSONObject.ID_KEY field) +

+ +

+

+
Version:
+
$Id$
+
Author:
+
Tyutyunkov Vyacheslav (tve@softmotions.com)
+
+
+ +

+ + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class org.ejdb.bson.BSONObject
data, fields, ID_KEY
+  + + + + + + + + + + + + + + + + + + + +
+Constructor Summary
BSONQueryObject() + +
+           
BSONQueryObject(BSONObject src) + +
+           
BSONQueryObject(java.util.Map<java.lang.String,java.lang.Object> data) + +
+           
BSONQueryObject(java.lang.String key, + java.lang.Object value) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ BSONQueryObjectappend(java.lang.String key, + java.lang.Object value) + +
+          The same as BSONObject.put(String, Object) but return this
+ ObjectIdgetId() + +
+          Deprecated. BSON Query objects can not contains dedicated ObjectID
+protected  booleanisFieldsOrderImportant() + +
+          If returns true fields order will be checks on equal.
+ java.lang.Objectput(java.lang.String key, + java.lang.Object value) + +
+          Add new key->value to BSON object.
+ + + + + + + +
Methods inherited from class org.ejdb.bson.BSONObject
clear, containsField, equals, fields, get, hashCode, putAll, putAll, registerField, remove, size, toString
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+BSONQueryObject

+
+public BSONQueryObject()
+
+
+
+ +

+BSONQueryObject

+
+public BSONQueryObject(java.lang.String key,
+                       java.lang.Object value)
+
+
+
+ +

+BSONQueryObject

+
+public BSONQueryObject(java.util.Map<java.lang.String,java.lang.Object> data)
+
+
+
+ +

+BSONQueryObject

+
+public BSONQueryObject(BSONObject src)
+
+
+ + + + + + + + +
+Method Detail
+ +

+put

+
+public java.lang.Object put(java.lang.String key,
+                            java.lang.Object value)
+
+
Add new key->value to BSON object. +

+

+
Overrides:
put in class BSONObject
+
+
+ +
Returns:
added value
+
+
+
+ +

+append

+
+public BSONQueryObject append(java.lang.String key,
+                              java.lang.Object value)
+
+
The same as BSONObject.put(String, Object) but return this +

+

+
Overrides:
append in class BSONObject
+
+
+
+
+
+
+ +

+getId

+
+@Deprecated
+public ObjectId getId()
+
+
Deprecated. BSON Query objects can not contains dedicated ObjectID +

+

Returns id of BSON object (if specified) +

+

+
Overrides:
getId in class BSONObject
+
+
+ +
Returns:
id of BSON object (if specified)
+
+
+
+ +

+isFieldsOrderImportant

+
+protected boolean isFieldsOrderImportant()
+
+
If returns true fields order will be checks on equal. +

+

+
Overrides:
isFieldsOrderImportant in class BSONObject
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/driver/EJDB.html b/jejdb/doc/org/ejdb/driver/EJDB.html new file mode 100644 index 0000000..ed330e4 --- /dev/null +++ b/jejdb/doc/org/ejdb/driver/EJDB.html @@ -0,0 +1,864 @@ + + + + + + + +EJDB (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.ejdb.driver +
+Class EJDB

+
+java.lang.Object
+  extended by org.ejdb.driver.EJDB
+
+
+
+
public class EJDB
extends java.lang.Object
+ + +

+

+
Version:
+
$Id$
+
Author:
+
Tyutyunkov Vyacheslav (tve@softmotions.com)
+
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static intJBO_DEFAULT + +
+          Default open mode
+static intJBOCREAT + +
+          Create if db file not exists.
+static intJBOLCKNB + +
+          Lock without blocking.
+static intJBONOLCK + +
+          Open without locking.
+static intJBOREADER + +
+          Open as a reader.
+static intJBOTRUNC + +
+          Truncate db on open.
+static intJBOTSYNC + +
+          Synchronize every transaction.
+static intJBOWRITER + +
+          Open as a writer.
+  + + + + + + + + + + +
+Constructor Summary
EJDB() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidclose() + +
+          Close database.
+ voiddropCollection(java.lang.String cname) + +
+          Drop collection by name.
+ voiddropCollection(java.lang.String cname, + boolean prune) + +
+          Drop collection.
+ EJDBCollectionensureCollection(java.lang.String cname) + +
+          Automatically creates new collection if it does't exists with using default collection options
+ EJDBCollectionensureCollection(java.lang.String cname, + EJDBCollection.Options opts) + +
+          Automatically creates new collection if it does't exists.
+protected  voidfinalize() + +
+          
+ EJDBCollectiongetCollection(java.lang.String cname) + +
+          Returns collection object (without automatical creation)
+ EJDBCollectiongetCollection(java.lang.String cname, + boolean ecreate) + +
+          Returns collection object
+ EJDBCollectiongetCollection(java.lang.String cname, + boolean ecreate, + EJDBCollection.Options opts) + +
+          Returns collection object
+ java.util.Collection<java.lang.String>getCollectionNames() + +
+          Returns names of existed collections
+ java.util.Collection<EJDBCollection>getCollections() + +
+          Returns collection objects for all existed collections
+ java.lang.StringgetPath() + +
+          Returns EJDB path
+ booleanisOpen() + +
+          Check if database in opened state.
+ voidopen(java.lang.String path) + +
+          Open database using default open mode.
+ voidopen(java.lang.String path, + int mode) + +
+          Open database.
+ voidsync() + +
+          Synchronize entire EJDB database and all its collections with storage.
+ java.lang.StringtoString() + +
+          
+ voidupdateMeta() + +
+          Update description of EJDB database and its collections.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+JBOREADER

+
+public static final int JBOREADER
+
+
Open as a reader. +

+

+
See Also:
Constant Field Values
+
+
+ +

+JBOWRITER

+
+public static final int JBOWRITER
+
+
Open as a writer. +

+

+
See Also:
Constant Field Values
+
+
+ +

+JBOCREAT

+
+public static final int JBOCREAT
+
+
Create if db file not exists. +

+

+
See Also:
Constant Field Values
+
+
+ +

+JBOTRUNC

+
+public static final int JBOTRUNC
+
+
Truncate db on open. +

+

+
See Also:
Constant Field Values
+
+
+ +

+JBONOLCK

+
+public static final int JBONOLCK
+
+
Open without locking. +

+

+
See Also:
Constant Field Values
+
+
+ +

+JBOLCKNB

+
+public static final int JBOLCKNB
+
+
Lock without blocking. +

+

+
See Also:
Constant Field Values
+
+
+ +

+JBOTSYNC

+
+public static final int JBOTSYNC
+
+
Synchronize every transaction. +

+

+
See Also:
Constant Field Values
+
+
+ +

+JBO_DEFAULT

+
+public static final int JBO_DEFAULT
+
+
Default open mode +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+EJDB

+
+public EJDB()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getPath

+
+public java.lang.String getPath()
+
+
Returns EJDB path +

+

+ +
Returns:
EJDB path
+
+
+
+ +

+open

+
+public void open(java.lang.String path)
+          throws EJDBException
+
+
Open database using default open mode. +

+ Default open mode: JBOWRITER | JBOCREAT | JBOTSYNC +

+

+
Parameters:
path - EJDB path +
Throws: +
EJDBException
+
+
+
+ +

+open

+
+public void open(java.lang.String path,
+                 int mode)
+          throws EJDBException
+
+
Open database. +

+ Default open mode: JBOWRITER | JBOCREAT | JBOTSYNC +

+

+
Parameters:
path - EJDB path
mode - Open mode +
Throws: +
EJDBException
+
+
+
+ +

+isOpen

+
+public boolean isOpen()
+
+
Check if database in opened state. +

+

+
+
+
+
+ +

+close

+
+public void close()
+           throws EJDBException
+
+
Close database. + If database was not opened it does nothing. +

+

+ +
Throws: +
EJDBException
+
+
+
+ +

+sync

+
+public void sync()
+          throws EJDBException
+
+
Synchronize entire EJDB database and all its collections with storage. +

+

+ +
Throws: +
EJDBException
+
+
+
+ +

+updateMeta

+
+public void updateMeta()
+                throws EJDBException
+
+
Update description of EJDB database and its collections. +

+

+ +
Throws: +
EJDBException
+
+
+
+ +

+ensureCollection

+
+public EJDBCollection ensureCollection(java.lang.String cname)
+                                throws EJDBException
+
+
Automatically creates new collection if it does't exists with using default collection options +

+

+
Parameters:
cname - Collection name +
Throws: +
EJDBException
See Also:
EJDBCollection.ensureExists()
+
+
+
+ +

+ensureCollection

+
+public EJDBCollection ensureCollection(java.lang.String cname,
+                                       EJDBCollection.Options opts)
+                                throws EJDBException
+
+
Automatically creates new collection if it does't exists. + Collection options `opts` are applied only for newly created collection. + For existing collections `opts` takes no effect. +

+

+
Parameters:
cname - Collection name
opts - Collection options +
Throws: +
EJDBException
See Also:
EJDBCollection.ensureExists(org.ejdb.driver.EJDBCollection.Options)
+
+
+
+ +

+dropCollection

+
+public void dropCollection(java.lang.String cname)
+                    throws EJDBException
+
+
Drop collection by name. +

+

+
Parameters:
cname - Collection name +
Throws: +
EJDBException
See Also:
EJDBCollection.drop()
+
+
+
+ +

+dropCollection

+
+public void dropCollection(java.lang.String cname,
+                           boolean prune)
+                    throws EJDBException
+
+
Drop collection. +

+

+
Parameters:
cname - Collection name
prune - If true the collection data will erased from disk. +
Throws: +
EJDBException
See Also:
EJDBCollection.drop(boolean)
+
+
+
+ +

+getCollection

+
+public EJDBCollection getCollection(java.lang.String cname)
+                             throws EJDBException
+
+
Returns collection object (without automatical creation) +

+

+
Parameters:
cname - Collection name +
Returns:
collection object +
Throws: +
EJDBException
See Also:
getCollection(String, boolean, org.ejdb.driver.EJDBCollection.Options)
+
+
+
+ +

+getCollection

+
+public EJDBCollection getCollection(java.lang.String cname,
+                                    boolean ecreate)
+                             throws EJDBException
+
+
Returns collection object +

+

+
Parameters:
cname - Collection name
ecreate - Automatically collection creation flag +
Returns:
collection object +
Throws: +
EJDBException
See Also:
getCollection(String, boolean, org.ejdb.driver.EJDBCollection.Options)
+
+
+
+ +

+getCollection

+
+public EJDBCollection getCollection(java.lang.String cname,
+                                    boolean ecreate,
+                                    EJDBCollection.Options opts)
+                             throws EJDBException
+
+
Returns collection object +

+

+
Parameters:
cname - Collection name
ecreate - Automatically collection creation flag
opts - Collection options +
Returns:
collection object +
Throws: +
EJDBException
+
+
+
+ +

+getCollectionNames

+
+public java.util.Collection<java.lang.String> getCollectionNames()
+
+
Returns names of existed collections +

+

+
+
+
+
+ +

+getCollections

+
+public java.util.Collection<EJDBCollection> getCollections()
+
+
Returns collection objects for all existed collections +

+

+
+
+
+
+ +

+toString

+
+public java.lang.String toString()
+
+
+

+

+
Overrides:
toString in class java.lang.Object
+
+
+
+
+
+
+ +

+finalize

+
+protected void finalize()
+                 throws java.lang.Throwable
+
+
+

+

+
Overrides:
finalize in class java.lang.Object
+
+
+ +
Throws: +
java.lang.Throwable
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/driver/EJDBCollection.Index.html b/jejdb/doc/org/ejdb/driver/EJDBCollection.Index.html new file mode 100644 index 0000000..564220f --- /dev/null +++ b/jejdb/doc/org/ejdb/driver/EJDBCollection.Index.html @@ -0,0 +1,370 @@ + + + + + + + +EJDBCollection.Index (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.ejdb.driver +
+Class EJDBCollection.Index

+
+java.lang.Object
+  extended by org.ejdb.driver.EJDBCollection.Index
+
+
+
Enclosing class:
EJDBCollection
+
+
+
+
public static class EJDBCollection.Index
extends java.lang.Object
+ + +

+Index meta information +

+ +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
EJDBCollection.Index() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ java.lang.StringgetField() + +
+          Returns index field path
+ java.lang.StringgetFile() + +
+          Returns index file path
+ java.lang.StringgetName() + +
+          Returns index name
+ intgetRecords() + +
+          Returns records count in index
+ EJDBCollection.IndexTypegetType() + +
+          Returns index type
+ java.lang.StringtoString() + +
+          
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+EJDBCollection.Index

+
+public EJDBCollection.Index()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getName

+
+public java.lang.String getName()
+
+
Returns index name +

+

+
+
+
+
+ +

+getField

+
+public java.lang.String getField()
+
+
Returns index field path +

+

+
+
+
+
+ +

+getType

+
+public EJDBCollection.IndexType getType()
+
+
Returns index type +

+

+
+
+
+
+ +

+getFile

+
+public java.lang.String getFile()
+
+
Returns index file path +

+

+
+
+
+
+ +

+getRecords

+
+public int getRecords()
+
+
Returns records count in index +

+

+
+
+
+
+ +

+toString

+
+public java.lang.String toString()
+
+
+

+

+
Overrides:
toString in class java.lang.Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/driver/EJDBCollection.IndexType.html b/jejdb/doc/org/ejdb/driver/EJDBCollection.IndexType.html new file mode 100644 index 0000000..3ff4d19 --- /dev/null +++ b/jejdb/doc/org/ejdb/driver/EJDBCollection.IndexType.html @@ -0,0 +1,346 @@ + + + + + + + +EJDBCollection.IndexType (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.ejdb.driver +
+Enum EJDBCollection.IndexType

+
+java.lang.Object
+  extended by java.lang.Enum<EJDBCollection.IndexType>
+      extended by org.ejdb.driver.EJDBCollection.IndexType
+
+
+
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<EJDBCollection.IndexType>
+
+
+
Enclosing class:
EJDBCollection
+
+
+
+
public static enum EJDBCollection.IndexType
extends java.lang.Enum<EJDBCollection.IndexType>
+ + +

+Index types +

+ +

+


+ +

+ + + + + + + + + + + + + + + + +
+Enum Constant Summary
Lexical + +
+           
Numeric + +
+           
Token + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static EJDBCollection.IndexTypevalueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static EJDBCollection.IndexType[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+ + + + + + + +
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+ + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+Lexical

+
+public static final EJDBCollection.IndexType Lexical
+
+
+
+
+
+ +

+Numeric

+
+public static final EJDBCollection.IndexType Numeric
+
+
+
+
+
+ +

+Token

+
+public static final EJDBCollection.IndexType Token
+
+
+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static EJDBCollection.IndexType[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (EJDBCollection.IndexType c : EJDBCollection.IndexType.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static EJDBCollection.IndexType valueOf(java.lang.String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name +
java.lang.NullPointerException - if the argument is null
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/driver/EJDBCollection.Options.html b/jejdb/doc/org/ejdb/driver/EJDBCollection.Options.html new file mode 100644 index 0000000..0248ac0 --- /dev/null +++ b/jejdb/doc/org/ejdb/driver/EJDBCollection.Options.html @@ -0,0 +1,363 @@ + + + + + + + +EJDBCollection.Options (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.ejdb.driver +
+Class EJDBCollection.Options

+
+java.lang.Object
+  extended by org.ejdb.driver.EJDBCollection.Options
+
+
+
Enclosing class:
EJDBCollection
+
+
+
+
public static class EJDBCollection.Options
extends java.lang.Object
+ + +

+Collection meta information (and creation options) +

+ +

+


+ +

+ + + + + + + + + + + + + + +
+Constructor Summary
EJDBCollection.Options() + +
+           
EJDBCollection.Options(boolean compressed, + boolean large, + long records, + int cachedRecords) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ longgetBuckets() + +
+           
+ intgetCachedRecords() + +
+           
+ booleanisCompressed() + +
+           
+ booleanisLarge() + +
+           
+ java.lang.StringtoString() + +
+          
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+EJDBCollection.Options

+
+public EJDBCollection.Options()
+
+
+
+ +

+EJDBCollection.Options

+
+public EJDBCollection.Options(boolean compressed,
+                              boolean large,
+                              long records,
+                              int cachedRecords)
+
+
+
Parameters:
compressed - If true collection records will be compressed with DEFLATE compression. Default: false.
large - Specifies that the size of the database can be larger than 2GB. Default: false.
records - Estimated number of records in this collection. Default: 65535.
cachedRecords - Max number of cached records in shared memory segment. Default: 0
+
+ + + + + + + + +
+Method Detail
+ +

+getBuckets

+
+public long getBuckets()
+
+
+
+
+
+
+ +

+isCompressed

+
+public boolean isCompressed()
+
+
+
+
+
+
+ +

+isLarge

+
+public boolean isLarge()
+
+
+
+
+
+
+ +

+getCachedRecords

+
+public int getCachedRecords()
+
+
+
+
+
+
+ +

+toString

+
+public java.lang.String toString()
+
+
+

+

+
Overrides:
toString in class java.lang.Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/driver/EJDBCollection.html b/jejdb/doc/org/ejdb/driver/EJDBCollection.html new file mode 100644 index 0000000..bf05c24 --- /dev/null +++ b/jejdb/doc/org/ejdb/driver/EJDBCollection.html @@ -0,0 +1,1481 @@ + + + + + + + +EJDBCollection (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.ejdb.driver +
+Class EJDBCollection

+
+java.lang.Object
+  extended by org.ejdb.driver.EJDBCollection
+
+
+
+
public class EJDBCollection
extends java.lang.Object
+ + +

+

+
Version:
+
$Id$
+
Author:
+
Tyutyunkov Vyacheslav (tve@softmotions.com)
+
+
+ +

+ + + + + + + + + + + + + + + + + + + +
+Nested Class Summary
+static classEJDBCollection.Index + +
+          Index meta information
+static classEJDBCollection.IndexType + +
+          Index types
+static classEJDBCollection.Options + +
+          Collection meta information (and creation options)
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static intJBIDXARR + +
+          Array token index.
+static intJBIDXDROP + +
+          Drop index.
+static intJBIDXDROPALL + +
+          Drop index for all types.
+static intJBIDXISTR + +
+          Case insensitive string index
+static intJBIDXNUM + +
+          Number index.
+static intJBIDXOP + +
+          Optimize index.
+static intJBIDXREBLD + +
+          Rebuild index.
+static intJBIDXSTR + +
+          String index.
+protected static intJBTXBEGIN + +
+           
+protected static intJBTXCOMMIT + +
+           
+protected static intJBTXROLLBACK + +
+           
+protected static intJBTXSTATUS + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidbeginTransaction() + +
+          Begin collection transaction.
+ voidcommitTransaction() + +
+          Commit collection transaction.
+ EJDBQuerycreateQuery(BSONObject query) + +
+          Deprecated.  
+ EJDBQuerycreateQuery(BSONObject query, + BSONObject hints) + +
+          Deprecated.  
+ EJDBQuerycreateQuery(BSONObject query, + BSONObject[] qors) + +
+          Deprecated.  
+ EJDBQuerycreateQuery(BSONObject query, + BSONObject[] qors, + BSONObject hints) + +
+          Deprecated.  
+ EJDBQuerycreateQuery(EJDBQueryBuilder query) + +
+          Creates new EJDB Query for current collection.
+ voiddrop() + +
+          Drop collection.
+ voiddrop(boolean prune) + +
+          Drop collection.
+ voiddropArrayIndex(java.lang.String path) + +
+          Drop index of Array type for BSON field path.
+ voiddropIndexes(java.lang.String path) + +
+          Drops indexes of all types for BSON field path.
+ voiddropIStringIndex(java.lang.String path) + +
+          Drop case insensitive String index for BSON field path.
+ voiddropNumderIndex(java.lang.String path) + +
+          Drop index of Number type for BSON field path.
+ voiddropStringIndex(java.lang.String path) + +
+          Drop index of String type for BSON field path.
+ voidensureArrayIndex(java.lang.String path) + +
+          Ensure index presence of Array type for BSON field path
+ voidensureExists() + +
+          Automatically creates new collection if it does't exists with using default collection options.
+ voidensureExists(EJDBCollection.Options opts) + +
+          Automatically creates new collection if it does't exists.
+ voidensureIStringIndex(java.lang.String path) + +
+          Ensure case insensitive String index for BSON field path
+ voidensureNumderIndex(java.lang.String path) + +
+          Ensure index presence of Number type for BSON field path
+ voidensureStringIndex(java.lang.String path) + +
+          Ensure index presence of String type for BSON field path
+ EJDBgetDB() + +
+          Returns EJDB object
+ java.util.Collection<EJDBCollection.Index>getIndexes() + +
+          Returns indexes info
+ java.lang.StringgetName() + +
+          Returns collection name
+ EJDBCollection.OptionsgetOptions() + +
+          Returns collection options EJDBCollection.Options
+ booleanisExists() + +
+          Returns collection exists status
+ booleanisTransactionActive() + +
+          Get collection transaction status.
+ BSONObjectload(ObjectId oid) + +
+          Loads BSON object identified by OID from the collection.
+ voidoptimizeIndexes(java.lang.String path) + +
+          Optimize indexes of all types for BSON field path
+ voidrebuildArrayIndex(java.lang.String path) + +
+          Rebuild index of Array type for BSON field path.
+ voidrebuildIStringIndex(java.lang.String path) + +
+          Rebuild case insensitive String index for BSON field path.
+ voidrebuildNumderIndex(java.lang.String path) + +
+          Rebuild index of Number type for BSON field path.
+ voidrebuildStringIndex(java.lang.String path) + +
+          Rebuild index of String type for BSON field path.
+ voidremove(ObjectId oid) + +
+          Remove BSON object from collection by OID
+ voidrollbackTransaction() + +
+          Abort collection transaction.
+ ObjectIdsave(BSONObject object) + +
+          Save/update specified BSON object in the collection.
+ java.util.List<ObjectId>save(java.util.List<BSONObject> objects) + +
+          Save/update specified BSON objects in the collection.
+protected  voidsetIndex(java.lang.String path, + int flags) + +
+           
+ voidsync() + +
+          Synchronize entire collection with storage.
+ java.lang.StringtoString() + +
+          
+protected  booleantxControl(int mode) + +
+           
+ voidupdateMeta() + +
+          Update collection metainformation from storage
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+JBIDXDROP

+
+public static final int JBIDXDROP
+
+
Drop index. +

+

+
See Also:
Constant Field Values
+
+
+ +

+JBIDXDROPALL

+
+public static final int JBIDXDROPALL
+
+
Drop index for all types. +

+

+
See Also:
Constant Field Values
+
+
+ +

+JBIDXOP

+
+public static final int JBIDXOP
+
+
Optimize index. +

+

+
See Also:
Constant Field Values
+
+
+ +

+JBIDXREBLD

+
+public static final int JBIDXREBLD
+
+
Rebuild index. +

+

+
See Also:
Constant Field Values
+
+
+ +

+JBIDXNUM

+
+public static final int JBIDXNUM
+
+
Number index. +

+

+
See Also:
Constant Field Values
+
+
+ +

+JBIDXSTR

+
+public static final int JBIDXSTR
+
+
String index. +

+

+
See Also:
Constant Field Values
+
+
+ +

+JBIDXARR

+
+public static final int JBIDXARR
+
+
Array token index. +

+

+
See Also:
Constant Field Values
+
+
+ +

+JBIDXISTR

+
+public static final int JBIDXISTR
+
+
Case insensitive string index +

+

+
See Also:
Constant Field Values
+
+
+ +

+JBTXBEGIN

+
+protected static final int JBTXBEGIN
+
+
+
See Also:
Constant Field Values
+
+
+ +

+JBTXCOMMIT

+
+protected static final int JBTXCOMMIT
+
+
+
See Also:
Constant Field Values
+
+
+ +

+JBTXROLLBACK

+
+protected static final int JBTXROLLBACK
+
+
+
See Also:
Constant Field Values
+
+
+ +

+JBTXSTATUS

+
+protected static final int JBTXSTATUS
+
+
+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Method Detail
+ +

+getDB

+
+public EJDB getDB()
+
+
Returns EJDB object +

+

+ +
Returns:
EJDB object
+
+
+
+ +

+getName

+
+public java.lang.String getName()
+
+
Returns collection name +

+

+ +
Returns:
collection name
+
+
+
+ +

+isExists

+
+public boolean isExists()
+
+
Returns collection exists status +

+

+ +
Returns:
collection exists status
+
+
+
+ +

+getOptions

+
+public EJDBCollection.Options getOptions()
+
+
Returns collection options EJDBCollection.Options +

+

+ +
Returns:
collection options EJDBCollection.Options
+
+
+
+ +

+getIndexes

+
+public java.util.Collection<EJDBCollection.Index> getIndexes()
+
+
Returns indexes info +

+

+ +
Returns:
indexes info
+
+
+
+ +

+ensureExists

+
+public void ensureExists()
+                  throws EJDBException
+
+
Automatically creates new collection if it does't exists with using default collection options. +

+

+ +
Throws: +
EJDBException
See Also:
ensureExists(org.ejdb.driver.EJDBCollection.Options)
+
+
+
+ +

+ensureExists

+
+public void ensureExists(EJDBCollection.Options opts)
+                  throws EJDBException
+
+
Automatically creates new collection if it does't exists. + Collection options `opts` are applied only for newly created collection. + For existing collections `opts` takes no effect. +

+

+
Parameters:
opts - Collection options. +
Throws: +
EJDBException
+
+
+
+ +

+drop

+
+public void drop()
+          throws EJDBException
+
+
Drop collection. +

+

+ +
Throws: +
EJDBException
+
+
+
+ +

+drop

+
+public void drop(boolean prune)
+          throws EJDBException
+
+
Drop collection. +

+

+
Parameters:
prune - If true the collection data will erased from disk. +
Throws: +
EJDBException
+
+
+
+ +

+sync

+
+public void sync()
+          throws EJDBException
+
+
Synchronize entire collection with storage. +

+

+ +
Throws: +
EJDBException
+
+
+
+ +

+updateMeta

+
+public void updateMeta()
+                throws EJDBException
+
+
Update collection metainformation from storage +

+

+ +
Throws: +
EJDBException
+
+
+
+ +

+load

+
+public BSONObject load(ObjectId oid)
+                throws EJDBException
+
+
Loads BSON object identified by OID from the collection. +

+

+
Parameters:
oid - Object identifier (OID) +
Throws: +
EJDBException
+
+
+
+ +

+save

+
+public ObjectId save(BSONObject object)
+              throws EJDBException
+
+
Save/update specified BSON object in the collection. +

+ Object has unique identifier (OID) placed in the `_id` property. + If a saved object does not have `_id` it will be autogenerated. + To identify and update object it should contains `_id` property. +

+ NOTE: Field names of passed BSON objects may not contain `$` and `.` characters, + error condition will be fired in this case. +

+

+
Parameters:
object - BSON object to save +
Returns:
OID of saved object +
Throws: +
EJDBException
+
+
+
+ +

+save

+
+public java.util.List<ObjectId> save(java.util.List<BSONObject> objects)
+                              throws EJDBException
+
+
Save/update specified BSON objects in the collection. +

+ Each persistent object has unique identifier (OID) placed in the `_id` property. + If a saved object does not have `_id` it will be autogenerated. + To identify and update object it should contains `_id` property. +

+ NOTE: Field names of passed BSON objects may not contain `$` and `.` characters, + error condition will be fired in this case. +

+

+
Parameters:
objects - array of JSON objects to save +
Returns:
OIDs of saved objects +
Throws: +
EJDBException
+
+
+
+ +

+remove

+
+public void remove(ObjectId oid)
+            throws EJDBException
+
+
Remove BSON object from collection by OID +

+

+
Parameters:
oid - OID of removed object +
Throws: +
EJDBException
+
+
+
+ +

+setIndex

+
+protected void setIndex(java.lang.String path,
+                        int flags)
+                 throws EJDBException
+
+
+
Parameters:
path - BSON field path
flags - +
Throws: +
EJDBException
+
+
+
+ +

+dropIndexes

+
+public void dropIndexes(java.lang.String path)
+                 throws EJDBException
+
+
Drops indexes of all types for BSON field path. +

+

+
Parameters:
path - BSON field path +
Throws: +
EJDBException
+
+
+
+ +

+optimizeIndexes

+
+public void optimizeIndexes(java.lang.String path)
+                     throws EJDBException
+
+
Optimize indexes of all types for BSON field path +

+

+
Parameters:
path - BSON field path +
Throws: +
EJDBException
+
+
+
+ +

+ensureStringIndex

+
+public void ensureStringIndex(java.lang.String path)
+                       throws EJDBException
+
+
Ensure index presence of String type for BSON field path +

+

+
Parameters:
path - BSON field path +
Throws: +
EJDBException
+
+
+
+ +

+rebuildStringIndex

+
+public void rebuildStringIndex(java.lang.String path)
+                        throws EJDBException
+
+
Rebuild index of String type for BSON field path. +

+

+
Parameters:
path - BSON field path +
Throws: +
EJDBException
+
+
+
+ +

+dropStringIndex

+
+public void dropStringIndex(java.lang.String path)
+                     throws EJDBException
+
+
Drop index of String type for BSON field path. +

+

+
Parameters:
path - BSON field path +
Throws: +
EJDBException
+
+
+
+ +

+ensureIStringIndex

+
+public void ensureIStringIndex(java.lang.String path)
+                        throws EJDBException
+
+
Ensure case insensitive String index for BSON field path +

+

+
Parameters:
path - BSON field path +
Throws: +
EJDBException
+
+
+
+ +

+rebuildIStringIndex

+
+public void rebuildIStringIndex(java.lang.String path)
+                         throws EJDBException
+
+
Rebuild case insensitive String index for BSON field path. +

+

+
Parameters:
path - BSON field path +
Throws: +
EJDBException
+
+
+
+ +

+dropIStringIndex

+
+public void dropIStringIndex(java.lang.String path)
+                      throws EJDBException
+
+
Drop case insensitive String index for BSON field path. +

+

+
Parameters:
path - BSON field path +
Throws: +
EJDBException
+
+
+
+ +

+ensureNumderIndex

+
+public void ensureNumderIndex(java.lang.String path)
+                       throws EJDBException
+
+
Ensure index presence of Number type for BSON field path +

+

+
Parameters:
path - BSON field path +
Throws: +
EJDBException
+
+
+
+ +

+rebuildNumderIndex

+
+public void rebuildNumderIndex(java.lang.String path)
+                        throws EJDBException
+
+
Rebuild index of Number type for BSON field path. +

+

+
Parameters:
path - BSON field path +
Throws: +
EJDBException
+
+
+
+ +

+dropNumderIndex

+
+public void dropNumderIndex(java.lang.String path)
+                     throws EJDBException
+
+
Drop index of Number type for BSON field path. +

+

+
Parameters:
path - BSON field path +
Throws: +
EJDBException
+
+
+
+ +

+ensureArrayIndex

+
+public void ensureArrayIndex(java.lang.String path)
+                      throws EJDBException
+
+
Ensure index presence of Array type for BSON field path +

+

+
Parameters:
path - BSON field path +
Throws: +
EJDBException
+
+
+
+ +

+rebuildArrayIndex

+
+public void rebuildArrayIndex(java.lang.String path)
+                       throws EJDBException
+
+
Rebuild index of Array type for BSON field path. +

+

+
Parameters:
path - BSON field path +
Throws: +
EJDBException
+
+
+
+ +

+dropArrayIndex

+
+public void dropArrayIndex(java.lang.String path)
+                    throws EJDBException
+
+
Drop index of Array type for BSON field path. +

+

+
Parameters:
path - BSON field path +
Throws: +
EJDBException
+
+
+
+ +

+createQuery

+
+public EJDBQuery createQuery(EJDBQueryBuilder query)
+
+
Creates new EJDB Query for current collection. +

+

+
+
+
+
+ +

+createQuery

+
+@Deprecated
+public EJDBQuery createQuery(BSONObject query)
+
+
Deprecated.  +

+

+
See Also:
createQuery(org.ejdb.bson.BSONObject, org.ejdb.bson.BSONObject[], org.ejdb.bson.BSONObject)
+
+
+
+ +

+createQuery

+
+@Deprecated
+public EJDBQuery createQuery(BSONObject query,
+                                        BSONObject[] qors)
+
+
Deprecated.  +

+

+
See Also:
createQuery(org.ejdb.bson.BSONObject, org.ejdb.bson.BSONObject[], org.ejdb.bson.BSONObject)
+
+
+
+ +

+createQuery

+
+@Deprecated
+public EJDBQuery createQuery(BSONObject query,
+                                        BSONObject hints)
+
+
Deprecated.  +

+

+
See Also:
createQuery(org.ejdb.bson.BSONObject, org.ejdb.bson.BSONObject[], org.ejdb.bson.BSONObject)
+
+
+
+ +

+createQuery

+
+@Deprecated
+public EJDBQuery createQuery(BSONObject query,
+                                        BSONObject[] qors,
+                                        BSONObject hints)
+
+
Deprecated.  +

+

Create EJDB query +

+ EJDB queries inspired by MongoDB (mongodb.org) and follows same philosophy. +

+

+
Parameters:
query - Main BSON query object
qors - Array of additional OR query objects (joined with OR predicate).
hints - BSON object with query hints.
+
+
+
+ +

+beginTransaction

+
+public void beginTransaction()
+                      throws EJDBException
+
+
Begin collection transaction. +

+

+ +
Throws: +
EJDBException
+
+
+
+ +

+commitTransaction

+
+public void commitTransaction()
+                       throws EJDBException
+
+
Commit collection transaction. +

+

+ +
Throws: +
EJDBException
+
+
+
+ +

+rollbackTransaction

+
+public void rollbackTransaction()
+                         throws EJDBException
+
+
Abort collection transaction. +

+

+ +
Throws: +
EJDBException
+
+
+
+ +

+isTransactionActive

+
+public boolean isTransactionActive()
+                            throws EJDBException
+
+
Get collection transaction status. +

+

+ +
Throws: +
EJDBException
+
+
+
+ +

+txControl

+
+protected boolean txControl(int mode)
+                     throws EJDBException
+
+
+ +
Throws: +
EJDBException
+
+
+
+ +

+toString

+
+public java.lang.String toString()
+
+
+

+

+
Overrides:
toString in class java.lang.Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/driver/EJDBException.html b/jejdb/doc/org/ejdb/driver/EJDBException.html new file mode 100644 index 0000000..c3a56c4 --- /dev/null +++ b/jejdb/doc/org/ejdb/driver/EJDBException.html @@ -0,0 +1,334 @@ + + + + + + + +EJDBException (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.ejdb.driver +
+Class EJDBException

+
+java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by org.ejdb.driver.EJDBException
+
+
+
All Implemented Interfaces:
java.io.Serializable
+
+
+
+
public class EJDBException
extends java.lang.RuntimeException
+ + +

+

+
Version:
+
$Id$
+
Author:
+
Tyutyunkov Vyacheslav (tve@softmotions.com)
+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + + +
+Constructor Summary
EJDBException() + +
+           
EJDBException(int code, + java.lang.String message) + +
+           
EJDBException(java.lang.String message) + +
+           
EJDBException(java.lang.String message, + java.lang.Throwable cause) + +
+           
EJDBException(java.lang.Throwable cause) + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ intgetCode() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+EJDBException

+
+public EJDBException()
+
+
+
+ +

+EJDBException

+
+public EJDBException(java.lang.String message)
+
+
+
+ +

+EJDBException

+
+public EJDBException(java.lang.String message,
+                     java.lang.Throwable cause)
+
+
+
+ +

+EJDBException

+
+public EJDBException(java.lang.Throwable cause)
+
+
+
+ +

+EJDBException

+
+public EJDBException(int code,
+                     java.lang.String message)
+
+
+ + + + + + + + +
+Method Detail
+ +

+getCode

+
+public int getCode()
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/driver/EJDBQuery.html b/jejdb/doc/org/ejdb/driver/EJDBQuery.html new file mode 100644 index 0000000..9f8e33b --- /dev/null +++ b/jejdb/doc/org/ejdb/driver/EJDBQuery.html @@ -0,0 +1,509 @@ + + + + + + + +EJDBQuery (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.ejdb.driver +
+Class EJDBQuery

+
+java.lang.Object
+  extended by org.ejdb.driver.EJDBQuery
+
+
+
+
public class EJDBQuery
extends java.lang.Object
+ + +

+EJDB Query object. +

+ +

+

+
Version:
+
$Id$
+
Author:
+
Tyutyunkov Vyacheslav (tve@softmotions.com)
+
+
+ +

+ + + + + + + + + + + +
+Field Summary
+protected static intJBQRYCOUNT + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ intcount() + +
+          Convenient count(*) operation
+ intcount(java.io.OutputStream log) + +
+          Convenient count(*) operation
+protected  org.ejdb.driver.EJDBQuery.QResultexecute(BSONObject query, + BSONObject[] qors, + BSONObject hints, + int flags, + java.io.OutputStream log) + +
+           
+protected  org.ejdb.driver.EJDBQuery.QResultexecute(BSONObject hints, + int flags, + java.io.OutputStream log) + +
+           
+ EJDBResultSetfind() + +
+          Execute query
+ EJDBResultSetfind(java.io.OutputStream log) + +
+          Execute query
+ BSONObjectfindOne() + +
+          Same as find() but retrieves only one matching JSON object.
+ BSONObjectfindOne(java.io.OutputStream log) + +
+          Same as find() but retrieves only one matching JSON object.
+ intupdate() + +
+          Executes update query
+ intupdate(java.io.OutputStream log) + +
+          Executes update query
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+JBQRYCOUNT

+
+protected static final int JBQRYCOUNT
+
+
+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Method Detail
+ +

+find

+
+public EJDBResultSet find()
+                   throws EJDBException
+
+
Execute query +

+

+ +
Throws: +
EJDBException
+
+
+
+ +

+find

+
+public EJDBResultSet find(java.io.OutputStream log)
+                   throws EJDBException,
+                          java.io.IOException
+
+
Execute query +

+

+ +
Throws: +
EJDBException +
java.io.IOException
+
+
+
+ +

+findOne

+
+public BSONObject findOne()
+                   throws EJDBException
+
+
Same as find() but retrieves only one matching JSON object. +

+

+ +
Throws: +
EJDBException
+
+
+
+ +

+findOne

+
+public BSONObject findOne(java.io.OutputStream log)
+                   throws EJDBException,
+                          java.io.IOException
+
+
Same as find() but retrieves only one matching JSON object. +

+

+ +
Throws: +
EJDBException +
java.io.IOException
+
+
+
+ +

+update

+
+public int update()
+           throws EJDBException
+
+
Executes update query +

+

+ +
Returns:
count of affected objects +
Throws: +
EJDBException
+
+
+
+ +

+update

+
+public int update(java.io.OutputStream log)
+           throws EJDBException,
+                  java.io.IOException
+
+
Executes update query +

+

+ +
Returns:
count of affected objects +
Throws: +
EJDBException +
java.io.IOException
+
+
+
+ +

+count

+
+public int count()
+          throws EJDBException
+
+
Convenient count(*) operation +

+

+ +
Throws: +
EJDBException
+
+
+
+ +

+count

+
+public int count(java.io.OutputStream log)
+          throws EJDBException,
+                 java.io.IOException
+
+
Convenient count(*) operation +

+

+ +
Throws: +
EJDBException +
java.io.IOException
+
+
+
+ +

+execute

+
+protected org.ejdb.driver.EJDBQuery.QResult execute(BSONObject hints,
+                                                    int flags,
+                                                    java.io.OutputStream log)
+                                             throws EJDBException,
+                                                    java.io.IOException
+
+
+ +
Throws: +
EJDBException +
java.io.IOException
+
+
+
+ +

+execute

+
+protected org.ejdb.driver.EJDBQuery.QResult execute(BSONObject query,
+                                                    BSONObject[] qors,
+                                                    BSONObject hints,
+                                                    int flags,
+                                                    java.io.OutputStream log)
+                                             throws EJDBException,
+                                                    java.io.IOException
+
+
+ +
Throws: +
EJDBException +
java.io.IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/driver/EJDBQueryBuilder.Constraint.html b/jejdb/doc/org/ejdb/driver/EJDBQueryBuilder.Constraint.html new file mode 100644 index 0000000..1b79b4e --- /dev/null +++ b/jejdb/doc/org/ejdb/driver/EJDBQueryBuilder.Constraint.html @@ -0,0 +1,743 @@ + + + + + + + +EJDBQueryBuilder.Constraint (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.ejdb.driver +
+Class EJDBQueryBuilder.Constraint

+
+java.lang.Object
+  extended by org.ejdb.driver.EJDBQueryBuilder.Constraint
+
+
+
Enclosing class:
EJDBQueryBuilder
+
+
+
+
public class EJDBQueryBuilder.Constraint
extends java.lang.Object
+ + +

+Find constraint for specified field +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + +
+Constructor Summary
+protected EJDBQueryBuilder.Constraint(java.lang.String field) + +
+           
+protected EJDBQueryBuilder.Constraint(java.lang.String field, + boolean replace) + +
+           
+protected EJDBQueryBuilder.Constraint(java.lang.String field, + EJDBQueryBuilder.Constraint parent) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+protected  EJDBQueryBuilderaddOperation(java.lang.Object value) + +
+          Add curently restrictons tree to query
+ EJDBQueryBuilderbegin(java.lang.String value) + +
+          Strins starts with prefix
+ EJDBQueryBuilderbt(java.lang.Number start, + java.lang.Number end) + +
+          Between number (start <= field_value <= end)
+ EJDBQueryBuildereq(java.lang.Object value) + +
+          Field equality restriction.
+ EJDBQueryBuilderexists() + +
+          Field existence matching exists(boolean)
+ EJDBQueryBuilderexists(boolean exists) + +
+          Field existence matching
+ EJDBQueryBuilder.Constraintfield(java.lang.String field) + +
+          Add inner constraint
+ EJDBQueryBuildergt(java.lang.Number value) + +
+          Greater than value (field_value > value)
+ EJDBQueryBuildergte(java.lang.Number value) + +
+          Greater than or equal value (field_value >= value)
+ EJDBQueryBuilder.Constrainticase() + +
+          Case insensitive string matching +

+ Example: + query.field(field).icase().eq(value); // -> {field : {$icase : value}} + query.field(field).icase().in(value1, value2); // -> {field : {$icase : {$in : [value1, value2]}}}

+ EJDBQueryBuilderin(java.util.Collection<java.lang.Object> values) + +
+          Field value matched any value of specified in values.
+ EJDBQueryBuilderin(java.lang.Object[] values) + +
+          Field value matched any value of specified in values.
+ EJDBQueryBuilderlt(java.lang.Number value) + +
+          Lesser then value (field_value < value)
+ EJDBQueryBuilderlte(java.lang.Number value) + +
+          Lesser then or equal value (field_value <= value)
+ EJDBQueryBuilder.Constraintnot() + +
+          Add $not negatiation constraint +

+ Example: + query.field(field).not().eq(value); // {field : { $not : value }} + query.field(field).not().bt(start, end); // {field : { $not : {$bt : [start, end]}}}

+ EJDBQueryBuildernotIn(java.util.Collection<java.lang.Object> values) + +
+          Negation of in(java.util.Collection)
+ EJDBQueryBuildernotIn(java.lang.Object[] values) + +
+          Negation of in(Object...)
+ EJDBQueryBuilderstrAnd(java.util.Collection<java.lang.String> values) + +
+          String tokens (or string array vals) matches all tokens in specified collection.
+ EJDBQueryBuilderstrAnd(java.lang.String[] values) + +
+          String tokens (or string array vals) matches all tokens in specified array.
+ EJDBQueryBuilderstrOr(java.util.Collection<java.lang.String> values) + +
+          String tokens (or string array vals) matches any tokens in specified collection.
+ EJDBQueryBuilderstrOr(java.lang.String[] values) + +
+          String tokens (or string array vals) matches any tokens in specified array.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+EJDBQueryBuilder.Constraint

+
+protected EJDBQueryBuilder.Constraint(java.lang.String field)
+
+
+
+ +

+EJDBQueryBuilder.Constraint

+
+protected EJDBQueryBuilder.Constraint(java.lang.String field,
+                                      boolean replace)
+
+
+
+ +

+EJDBQueryBuilder.Constraint

+
+protected EJDBQueryBuilder.Constraint(java.lang.String field,
+                                      EJDBQueryBuilder.Constraint parent)
+
+
+ + + + + + + + +
+Method Detail
+ +

+addOperation

+
+protected EJDBQueryBuilder addOperation(java.lang.Object value)
+
+
Add curently restrictons tree to query +

+

+
+
+
+
+ +

+not

+
+public EJDBQueryBuilder.Constraint not()
+
+
Add $not negatiation constraint +

+ Example: + query.field(field).not().eq(value); // {field : { $not : value }} + query.field(field).not().bt(start, end); // {field : { $not : {$bt : [start, end]}}} +

+

+
+
+
+
+ +

+field

+
+public EJDBQueryBuilder.Constraint field(java.lang.String field)
+
+
Add inner constraint +

+

+
+
+
+
+ +

+eq

+
+public EJDBQueryBuilder eq(java.lang.Object value)
+
+
Field equality restriction. + All usage samples represent same thing: {"field" : value} +

+ Example: + query.field(field, value); // -> {field : value} + query.field(field).eq(value); // -> {field : value} +

+

+
+
+
+
+ +

+gte

+
+public EJDBQueryBuilder gte(java.lang.Number value)
+
+
Greater than or equal value (field_value >= value) +

+

+
+
+
+
+ +

+gt

+
+public EJDBQueryBuilder gt(java.lang.Number value)
+
+
Greater than value (field_value > value) +

+

+
+
+
+
+ +

+lte

+
+public EJDBQueryBuilder lte(java.lang.Number value)
+
+
Lesser then or equal value (field_value <= value) +

+

+
+
+
+
+ +

+lt

+
+public EJDBQueryBuilder lt(java.lang.Number value)
+
+
Lesser then value (field_value < value) +

+

+
+
+
+
+ +

+bt

+
+public EJDBQueryBuilder bt(java.lang.Number start,
+                           java.lang.Number end)
+
+
Between number (start <= field_value <= end) +

+

+
+
+
+
+ +

+in

+
+public EJDBQueryBuilder in(java.lang.Object[] values)
+
+
Field value matched any value of specified in values. +

+

+
+
+
+
+ +

+in

+
+public EJDBQueryBuilder in(java.util.Collection<java.lang.Object> values)
+
+
Field value matched any value of specified in values. +

+

+
+
+
+
+ +

+notIn

+
+public EJDBQueryBuilder notIn(java.lang.Object[] values)
+
+
Negation of in(Object...) +

+

+
+
+
+
+ +

+notIn

+
+public EJDBQueryBuilder notIn(java.util.Collection<java.lang.Object> values)
+
+
Negation of in(java.util.Collection) +

+

+
+
+
+
+ +

+begin

+
+public EJDBQueryBuilder begin(java.lang.String value)
+
+
Strins starts with prefix +

+

+
+
+
+
+ +

+strAnd

+
+public EJDBQueryBuilder strAnd(java.lang.String[] values)
+
+
String tokens (or string array vals) matches all tokens in specified array. +

+

+
+
+
+
+ +

+strAnd

+
+public EJDBQueryBuilder strAnd(java.util.Collection<java.lang.String> values)
+
+
String tokens (or string array vals) matches all tokens in specified collection. +

+

+
+
+
+
+ +

+strOr

+
+public EJDBQueryBuilder strOr(java.lang.String[] values)
+
+
String tokens (or string array vals) matches any tokens in specified array. +

+

+
+
+
+
+ +

+strOr

+
+public EJDBQueryBuilder strOr(java.util.Collection<java.lang.String> values)
+
+
String tokens (or string array vals) matches any tokens in specified collection. +

+

+
+
+
+
+ +

+exists

+
+public EJDBQueryBuilder exists()
+
+
Field existence matching exists(boolean) +

+

+
+
+
+
+ +

+exists

+
+public EJDBQueryBuilder exists(boolean exists)
+
+
Field existence matching +

+

+
+
+
+
+ +

+icase

+
+public EJDBQueryBuilder.Constraint icase()
+
+
Case insensitive string matching +

+ Example: + query.field(field).icase().eq(value); // -> {field : {$icase : value}} + query.field(field).icase().in(value1, value2); // -> {field : {$icase : {$in : [value1, value2]}}} +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/driver/EJDBQueryBuilder.OrderBy.html b/jejdb/doc/org/ejdb/driver/EJDBQueryBuilder.OrderBy.html new file mode 100644 index 0000000..b9d1b44 --- /dev/null +++ b/jejdb/doc/org/ejdb/driver/EJDBQueryBuilder.OrderBy.html @@ -0,0 +1,329 @@ + + + + + + + +EJDBQueryBuilder.OrderBy (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.ejdb.driver +
+Class EJDBQueryBuilder.OrderBy

+
+java.lang.Object
+  extended by org.ejdb.driver.EJDBQueryBuilder.OrderBy
+
+
+
Enclosing class:
EJDBQueryBuilder
+
+
+
+
public class EJDBQueryBuilder.OrderBy
extends java.lang.Object
+ + +

+Sorting rules for query results +

+ +

+


+ +

+ + + + + + + + + + + + +
+Constructor Summary
+protected EJDBQueryBuilder.OrderBy(BSONObject orderBy) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ EJDBQueryBuilder.OrderByadd(java.lang.String field, + boolean asc) + +
+          Add sorting order for field
+ EJDBQueryBuilder.OrderByasc(java.lang.String field) + +
+          Add ascending sorting order for field
+ EJDBQueryBuilder.OrderByclear() + +
+          Clear all current sorting rules
+ EJDBQueryBuilder.OrderBydesc(java.lang.String field) + +
+          Add descinding sorting order for field
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+EJDBQueryBuilder.OrderBy

+
+protected EJDBQueryBuilder.OrderBy(BSONObject orderBy)
+
+
+ + + + + + + + +
+Method Detail
+ +

+asc

+
+public EJDBQueryBuilder.OrderBy asc(java.lang.String field)
+
+
Add ascending sorting order for field +

+

+
Parameters:
field - BSON field path
+
+
+
+ +

+desc

+
+public EJDBQueryBuilder.OrderBy desc(java.lang.String field)
+
+
Add descinding sorting order for field +

+

+
Parameters:
field - BSON field path
+
+
+
+ +

+add

+
+public EJDBQueryBuilder.OrderBy add(java.lang.String field,
+                                    boolean asc)
+
+
Add sorting order for field +

+

+
Parameters:
field - BSON field path
asc - if true ascendong sorting order, otherwise - descinding
+
+
+
+ +

+clear

+
+public EJDBQueryBuilder.OrderBy clear()
+
+
Clear all current sorting rules +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/driver/EJDBQueryBuilder.html b/jejdb/doc/org/ejdb/driver/EJDBQueryBuilder.html new file mode 100644 index 0000000..fe09174 --- /dev/null +++ b/jejdb/doc/org/ejdb/driver/EJDBQueryBuilder.html @@ -0,0 +1,964 @@ + + + + + + + +EJDBQueryBuilder (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.ejdb.driver +
+Class EJDBQueryBuilder

+
+java.lang.Object
+  extended by org.ejdb.driver.EJDBQueryBuilder
+
+
+
+
public class EJDBQueryBuilder
extends java.lang.Object
+ + +

+Query/BSON builder is used to create EJDB queries. + EJDBQueryBuilder can be used to construct BSON objects as well as queries. +

+ +

+

+
Version:
+
$Id$
+
Author:
+
Tyutyunkov Vyacheslav (tve@softmotions.com)
+
+
+ +

+ + + + + + + + + + + + + + + +
+Nested Class Summary
+ classEJDBQueryBuilder.Constraint + +
+          Find constraint for specified field
+ classEJDBQueryBuilder.OrderBy + +
+          Sorting rules for query results
+  + + + + + + + + + + + + + + + + + + + +
+Constructor Summary
+ EJDBQueryBuilder() + +
+           
+ EJDBQueryBuilder(BSONObject query, + java.util.List<BSONObject> queryOrs, + BSONObject hints) + +
+           
+protected EJDBQueryBuilder(EJDBQueryBuilder parent, + BSONObject query) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+protected  EJDBQueryBuilderaddHint(java.lang.String name, + java.lang.Object value) + +
+          Adds pair name->value to hints BSON object.
+protected  EJDBQueryBuilderaddOperation(java.lang.String field, + java.lang.Object value, + boolean replace) + +
+          Adds query restrintions in main query object.
+protected  voidaddToBSON(BSONObject out, + java.lang.String field, + java.lang.Object value) + +
+           
+ EJDBQueryBuilderaddToSet(java.lang.String field, + java.lang.Object value) + +
+          Atomically adds value to the array field only if value not in the array already.
+ EJDBQueryBuilderaddToSetAll(java.lang.String field, + java.util.Collection<java.lang.Object> values) + +
+          Atomically performs set union with values in val for specified array field.
+ EJDBQueryBuilderaddToSetAll(java.lang.String field, + java.lang.Object... values) + +
+          Atomically performs set union with values in val for specified array field.
+protected  voidcheckHintsAvailable() + +
+          Checks hints section allowed.
+ EJDBQueryBuilderdropAll() + +
+          In-place record removal operation.
+ EJDBQueryBuilderelementMatch(java.lang.String field) + +
+          Element match construction
+ EJDBQueryBuilderexcludeField(java.lang.String field) + +
+          Sets fields to be excluded from resulting objects.
+ EJDBQueryBuilder.Constraintfield(java.lang.String field) + +
+          Adds constraint for field
+ EJDBQueryBuilderfield(java.lang.String field, + java.lang.Object value) + +
+          Adds field equality restriction.
+ BSONObjectgetMainQuery() + +
+          Returns main BSON query object
+ BSONObject[]getOrQueries() + +
+          Returns BSON objects for additional OR queries
+ BSONObjectgetQueryHints() + +
+          Returns BSON hints object
+ EJDBQueryBuilderinc(java.lang.String field, + java.lang.Number inc) + +
+          Increment specified field.
+ EJDBQueryBuilderincludeField(java.lang.String field) + +
+          Sets fields to be included in resulting objects.
+ EJDBQueryBuilderjoin(java.lang.String fpath, + java.lang.String collname) + +
+          Make collection join for select queries.
+ EJDBQueryBuilderor() + +
+          Add OR joined query restrictions.
+ EJDBQueryBuilder.OrderByorderBy() + +
+          Resturs return sorting rules control object
+ EJDBQueryBuilderpull(java.lang.String field, + java.lang.Object value) + +
+          Atomically removes all occurrences of value from field, if field is an array.
+ EJDBQueryBuilderpullAll(java.lang.String field, + java.util.Collection<java.lang.Object> values) + +
+          Atomically performs set substraction of values for specified array field.
+ EJDBQueryBuilderpullAll(java.lang.String field, + java.lang.Object... values) + +
+          Atomically performs set substraction of values for specified array field.
+ EJDBQueryBuilderset(java.lang.String field, + java.lang.Object value) + +
+          Set specified fiels to value +

+ query.set(field1, value1).set(field2, value2); // -> { ..., $set : {field1 : value1, field2 : value2}}

+ EJDBQueryBuildersetFieldIncluded(java.lang.String field, + boolean incldue) + +
+          Sets fields to be included or exluded in resulting objects.
+ EJDBQueryBuildersetMaxResults(int maxResults) + +
+          Sets max number of records in the result set.
+ EJDBQueryBuildersetOffset(int offset) + +
+          Sets number of skipped records in the result set.
+ EJDBQueryBuilderupsert(java.lang.String field, + java.lang.Object value) + +
+          Atomic upsert.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+EJDBQueryBuilder

+
+public EJDBQueryBuilder()
+
+
+
+ +

+EJDBQueryBuilder

+
+public EJDBQueryBuilder(BSONObject query,
+                        java.util.List<BSONObject> queryOrs,
+                        BSONObject hints)
+
+
+
+ +

+EJDBQueryBuilder

+
+protected EJDBQueryBuilder(EJDBQueryBuilder parent,
+                           BSONObject query)
+
+
+ + + + + + + + +
+Method Detail
+ +

+getMainQuery

+
+public BSONObject getMainQuery()
+
+
Returns main BSON query object +

+

+ +
Returns:
main BSON query object
+
+
+
+ +

+getOrQueries

+
+public BSONObject[] getOrQueries()
+
+
Returns BSON objects for additional OR queries +

+

+ +
Returns:
BSON objects for additional OR queries
+
+
+
+ +

+getQueryHints

+
+public BSONObject getQueryHints()
+
+
Returns BSON hints object +

+

+ +
Returns:
BSON hints object
+
+
+
+ +

+addOperation

+
+protected EJDBQueryBuilder addOperation(java.lang.String field,
+                                        java.lang.Object value,
+                                        boolean replace)
+
+
Adds query restrintions in main query object. +

+

+
Parameters:
field - field path
value - field value
replace - if true all other restrictions will be replaces, otherwise trying to add restrictions for field
+
+
+
+ +

+addToBSON

+
+protected void addToBSON(BSONObject out,
+                         java.lang.String field,
+                         java.lang.Object value)
+
+
+
+
+
+
+ +

+checkHintsAvailable

+
+protected void checkHintsAvailable()
+                            throws EJDBException
+
+
Checks hints section allowed. +

+

+ +
Throws: +
EJDBException - if hints section if not allowed for current EJDBQueryBuilder object
+
+
+
+ +

+addHint

+
+protected EJDBQueryBuilder addHint(java.lang.String name,
+                                   java.lang.Object value)
+                            throws EJDBException
+
+
Adds pair name->value to hints BSON object. +

+

+ +
Throws: +
EJDBException - if hints section if not allowed for current EJDBQueryBuilder object
+
+
+
+ +

+field

+
+public EJDBQueryBuilder field(java.lang.String field,
+                              java.lang.Object value)
+
+
Adds field equality restriction. +

+ query.field(field, value); // -> {field : value} +

+

+
+
+
+
+ +

+field

+
+public EJDBQueryBuilder.Constraint field(java.lang.String field)
+
+
Adds constraint for field +

+

+
+
+
+
+ +

+elementMatch

+
+public EJDBQueryBuilder elementMatch(java.lang.String field)
+
+
Element match construction. + - $elemMatch The $elemMatch operator matches more than one component within an array element. + - { array: { $elemMatch: { value1 : 1, value2 : { $gt: 1 } } } } +

+ Restriction: only one $elemMatch allowed in context of one array field. +

+

+
+
+
+
+ +

+or

+
+public EJDBQueryBuilder or()
+                    throws EJDBException
+
+
Add OR joined query restrictions. +

+

+ +
Throws: +
EJDBException - if or section if not allowed for current EJDBQueryBuilder object (in ElementMatch-query, for example)
+
+
+
+ +

+set

+
+public EJDBQueryBuilder set(java.lang.String field,
+                            java.lang.Object value)
+
+
Set specified fiels to value +

+ query.set(field1, value1).set(field2, value2); // -> { ..., $set : {field1 : value1, field2 : value2}} +

+

+
+
+
+
+ +

+upsert

+
+public EJDBQueryBuilder upsert(java.lang.String field,
+                               java.lang.Object value)
+
+
Atomic upsert. + If matching records are found it will be $set operation, otherwise new record will be inserted with field specified by value. +

+ query.field(field, value).upsert(field, value); // -> {field : value, $upsert : {field : value}} +

+

+
+
+
+
+ +

+inc

+
+public EJDBQueryBuilder inc(java.lang.String field,
+                            java.lang.Number inc)
+
+
Increment specified field. Only number types are supported. +

+ query.int(field1, value1).int(field2, value2); // -> { ..., $int : {field1 : value1, field2 : value2}} +

+

+
+
+
+
+ +

+dropAll

+
+public EJDBQueryBuilder dropAll()
+
+
In-place record removal operation. +

+ Example: + Next update query removes all records with name eq 'andy': + query.field("name", "andy").dropAll() +

+

+
+
+
+
+ +

+addToSet

+
+public EJDBQueryBuilder addToSet(java.lang.String field,
+                                 java.lang.Object value)
+
+
Atomically adds value to the array field only if value not in the array already. If containing array is missing it will be created. +

+

+
+
+
+
+ +

+addToSetAll

+
+public EJDBQueryBuilder addToSetAll(java.lang.String field,
+                                    java.lang.Object... values)
+
+
Atomically performs set union with values in val for specified array field. +

+

+
+
+
+
+ +

+addToSetAll

+
+public EJDBQueryBuilder addToSetAll(java.lang.String field,
+                                    java.util.Collection<java.lang.Object> values)
+
+
Atomically performs set union with values in val for specified array field. +

+

+
+
+
+
+ +

+pull

+
+public EJDBQueryBuilder pull(java.lang.String field,
+                             java.lang.Object value)
+
+
Atomically removes all occurrences of value from field, if field is an array. +

+

+
+
+
+
+ +

+pullAll

+
+public EJDBQueryBuilder pullAll(java.lang.String field,
+                                java.lang.Object... values)
+
+
Atomically performs set substraction of values for specified array field. +

+

+
+
+
+
+ +

+pullAll

+
+public EJDBQueryBuilder pullAll(java.lang.String field,
+                                java.util.Collection<java.lang.Object> values)
+
+
Atomically performs set substraction of values for specified array field. +

+

+
+
+
+
+ +

+join

+
+public EJDBQueryBuilder join(java.lang.String fpath,
+                             java.lang.String collname)
+
+
Make collection join for select queries. +

+

+
+
+
+
+ +

+setMaxResults

+
+public EJDBQueryBuilder setMaxResults(int maxResults)
+
+
Sets max number of records in the result set. +

+

+
+
+
+
+ +

+setOffset

+
+public EJDBQueryBuilder setOffset(int offset)
+
+
Sets number of skipped records in the result set. +

+

+
+
+
+
+ +

+setFieldIncluded

+
+public EJDBQueryBuilder setFieldIncluded(java.lang.String field,
+                                         boolean incldue)
+
+
Sets fields to be included or exluded in resulting objects. + If field presented in $orderby clause it will be forced to include in resulting records. +

+

+
+
+
+
+ +

+includeField

+
+public EJDBQueryBuilder includeField(java.lang.String field)
+
+
Sets fields to be included in resulting objects. + If field presented in $orderby clause it will be forced to include in resulting records. +

+

+
+
+
+
+ +

+excludeField

+
+public EJDBQueryBuilder excludeField(java.lang.String field)
+
+
Sets fields to be excluded from resulting objects. + If field presented in $orderby clause it will be forced to include in resulting records. +

+

+
+
+
+
+ +

+orderBy

+
+public EJDBQueryBuilder.OrderBy orderBy()
+
+
Resturs return sorting rules control object +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/driver/EJDBResultSet.html b/jejdb/doc/org/ejdb/driver/EJDBResultSet.html new file mode 100644 index 0000000..831cd47 --- /dev/null +++ b/jejdb/doc/org/ejdb/driver/EJDBResultSet.html @@ -0,0 +1,414 @@ + + + + + + + +EJDBResultSet (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.ejdb.driver +
+Class EJDBResultSet

+
+java.lang.Object
+  extended by org.ejdb.driver.EJDBResultSet
+
+
+
All Implemented Interfaces:
java.lang.Iterable<BSONObject>, java.util.Iterator<BSONObject>
+
+
+
+
public class EJDBResultSet
extends java.lang.Object
implements java.lang.Iterable<BSONObject>, java.util.Iterator<BSONObject>
+ + +

+

+
Version:
+
$Id$
+
Author:
+
Tyutyunkov Vyacheslav (tve@softmotions.com)
+
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidclose() + +
+          Close result set
+protected  voidfinalize() + +
+          
+ BSONObjectget(int position) + +
+          Returns object by position
+ booleanhasNext() + +
+          
+ java.util.Iterator<BSONObject>iterator() + +
+          
+ intlength() + +
+          Returns objects count in result set
+ BSONObjectnext() + +
+          
+ voidremove() + +
+          
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Method Detail
+ +

+get

+
+public BSONObject get(int position)
+               throws EJDBException
+
+
Returns object by position +

+

+
+
+
+ +
Throws: +
EJDBException
+
+
+
+ +

+length

+
+public int length()
+
+
Returns objects count in result set +

+

+
+
+
+
+
+
+
+ +

+iterator

+
+public java.util.Iterator<BSONObject> iterator()
+
+
+

+

+
Specified by:
iterator in interface java.lang.Iterable<BSONObject>
+
+
+
+
+
+
+ +

+hasNext

+
+public boolean hasNext()
+
+
+

+

+
Specified by:
hasNext in interface java.util.Iterator<BSONObject>
+
+
+
+
+
+
+ +

+next

+
+public BSONObject next()
+                throws EJDBException
+
+
+

+

+
Specified by:
next in interface java.util.Iterator<BSONObject>
+
+
+ +
Throws: +
EJDBException
+
+
+
+ +

+remove

+
+public void remove()
+
+
+

+

+
Specified by:
remove in interface java.util.Iterator<BSONObject>
+
+
+
+
+
+
+ +

+close

+
+public void close()
+           throws EJDBException
+
+
Close result set +

+

+
+
+
+ +
Throws: +
EJDBException
+
+
+
+ +

+finalize

+
+protected void finalize()
+                 throws java.lang.Throwable
+
+
+

+

+
Overrides:
finalize in class java.lang.Object
+
+
+ +
Throws: +
java.lang.Throwable
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/driver/class-use/BSONQueryObject.html b/jejdb/doc/org/ejdb/driver/class-use/BSONQueryObject.html new file mode 100644 index 0000000..ed4064e --- /dev/null +++ b/jejdb/doc/org/ejdb/driver/class-use/BSONQueryObject.html @@ -0,0 +1,182 @@ + + + + + + + +Uses of Class org.ejdb.driver.BSONQueryObject (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
org.ejdb.driver.BSONQueryObject

+
+ + + + + + + + + +
+Packages that use BSONQueryObject
org.ejdb.driver  
+  +

+ + + + + +
+Uses of BSONQueryObject in org.ejdb.driver
+  +

+ + + + + + + + + +
Methods in org.ejdb.driver that return BSONQueryObject
+ BSONQueryObjectBSONQueryObject.append(java.lang.String key, + java.lang.Object value) + +
+          The same as BSONObject.put(String, Object) but return this
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/driver/class-use/EJDB.html b/jejdb/doc/org/ejdb/driver/class-use/EJDB.html new file mode 100644 index 0000000..6aeedde --- /dev/null +++ b/jejdb/doc/org/ejdb/driver/class-use/EJDB.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.ejdb.driver.EJDB (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
org.ejdb.driver.EJDB

+
+ + + + + + + + + +
+Packages that use EJDB
org.ejdb.driver  
+  +

+ + + + + +
+Uses of EJDB in org.ejdb.driver
+  +

+ + + + + + + + + +
Methods in org.ejdb.driver that return EJDB
+ EJDBEJDBCollection.getDB() + +
+          Returns EJDB object
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/driver/class-use/EJDBCollection.Index.html b/jejdb/doc/org/ejdb/driver/class-use/EJDBCollection.Index.html new file mode 100644 index 0000000..a19aac5 --- /dev/null +++ b/jejdb/doc/org/ejdb/driver/class-use/EJDBCollection.Index.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.ejdb.driver.EJDBCollection.Index (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
org.ejdb.driver.EJDBCollection.Index

+
+ + + + + + + + + +
+Packages that use EJDBCollection.Index
org.ejdb.driver  
+  +

+ + + + + +
+Uses of EJDBCollection.Index in org.ejdb.driver
+  +

+ + + + + + + + + +
Methods in org.ejdb.driver that return types with arguments of type EJDBCollection.Index
+ java.util.Collection<EJDBCollection.Index>EJDBCollection.getIndexes() + +
+          Returns indexes info
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/driver/class-use/EJDBCollection.IndexType.html b/jejdb/doc/org/ejdb/driver/class-use/EJDBCollection.IndexType.html new file mode 100644 index 0000000..b0ed577 --- /dev/null +++ b/jejdb/doc/org/ejdb/driver/class-use/EJDBCollection.IndexType.html @@ -0,0 +1,198 @@ + + + + + + + +Uses of Class org.ejdb.driver.EJDBCollection.IndexType (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
org.ejdb.driver.EJDBCollection.IndexType

+
+ + + + + + + + + +
+Packages that use EJDBCollection.IndexType
org.ejdb.driver  
+  +

+ + + + + +
+Uses of EJDBCollection.IndexType in org.ejdb.driver
+  +

+ + + + + + + + + + + + + + + + + +
Methods in org.ejdb.driver that return EJDBCollection.IndexType
+ EJDBCollection.IndexTypeEJDBCollection.Index.getType() + +
+          Returns index type
+static EJDBCollection.IndexTypeEJDBCollection.IndexType.valueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static EJDBCollection.IndexType[]EJDBCollection.IndexType.values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/driver/class-use/EJDBCollection.Options.html b/jejdb/doc/org/ejdb/driver/class-use/EJDBCollection.Options.html new file mode 100644 index 0000000..3072589 --- /dev/null +++ b/jejdb/doc/org/ejdb/driver/class-use/EJDBCollection.Options.html @@ -0,0 +1,216 @@ + + + + + + + +Uses of Class org.ejdb.driver.EJDBCollection.Options (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
org.ejdb.driver.EJDBCollection.Options

+
+ + + + + + + + + +
+Packages that use EJDBCollection.Options
org.ejdb.driver  
+  +

+ + + + + +
+Uses of EJDBCollection.Options in org.ejdb.driver
+  +

+ + + + + + + + + +
Methods in org.ejdb.driver that return EJDBCollection.Options
+ EJDBCollection.OptionsEJDBCollection.getOptions() + +
+          Returns collection options EJDBCollection.Options
+  +

+ + + + + + + + + + + + + + + + + +
Methods in org.ejdb.driver with parameters of type EJDBCollection.Options
+ EJDBCollectionEJDB.ensureCollection(java.lang.String cname, + EJDBCollection.Options opts) + +
+          Automatically creates new collection if it does't exists.
+ voidEJDBCollection.ensureExists(EJDBCollection.Options opts) + +
+          Automatically creates new collection if it does't exists.
+ EJDBCollectionEJDB.getCollection(java.lang.String cname, + boolean ecreate, + EJDBCollection.Options opts) + +
+          Returns collection object
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/driver/class-use/EJDBCollection.html b/jejdb/doc/org/ejdb/driver/class-use/EJDBCollection.html new file mode 100644 index 0000000..f132774 --- /dev/null +++ b/jejdb/doc/org/ejdb/driver/class-use/EJDBCollection.html @@ -0,0 +1,233 @@ + + + + + + + +Uses of Class org.ejdb.driver.EJDBCollection (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
org.ejdb.driver.EJDBCollection

+
+ + + + + + + + + +
+Packages that use EJDBCollection
org.ejdb.driver  
+  +

+ + + + + +
+Uses of EJDBCollection in org.ejdb.driver
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in org.ejdb.driver that return EJDBCollection
+ EJDBCollectionEJDB.ensureCollection(java.lang.String cname) + +
+          Automatically creates new collection if it does't exists with using default collection options
+ EJDBCollectionEJDB.ensureCollection(java.lang.String cname, + EJDBCollection.Options opts) + +
+          Automatically creates new collection if it does't exists.
+ EJDBCollectionEJDB.getCollection(java.lang.String cname) + +
+          Returns collection object (without automatical creation)
+ EJDBCollectionEJDB.getCollection(java.lang.String cname, + boolean ecreate) + +
+          Returns collection object
+ EJDBCollectionEJDB.getCollection(java.lang.String cname, + boolean ecreate, + EJDBCollection.Options opts) + +
+          Returns collection object
+  +

+ + + + + + + + + +
Methods in org.ejdb.driver that return types with arguments of type EJDBCollection
+ java.util.Collection<EJDBCollection>EJDB.getCollections() + +
+          Returns collection objects for all existed collections
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/driver/class-use/EJDBException.html b/jejdb/doc/org/ejdb/driver/class-use/EJDBException.html new file mode 100644 index 0000000..3d23e7b --- /dev/null +++ b/jejdb/doc/org/ejdb/driver/class-use/EJDBException.html @@ -0,0 +1,651 @@ + + + + + + + +Uses of Class org.ejdb.driver.EJDBException (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
org.ejdb.driver.EJDBException

+
+ + + + + + + + + +
+Packages that use EJDBException
org.ejdb.driver  
+  +

+ + + + + +
+Uses of EJDBException in org.ejdb.driver
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in org.ejdb.driver that throw EJDBException
+protected  EJDBQueryBuilderEJDBQueryBuilder.addHint(java.lang.String name, + java.lang.Object value) + +
+          Adds pair name->value to hints BSON object.
+ voidEJDBCollection.beginTransaction() + +
+          Begin collection transaction.
+protected  voidEJDBQueryBuilder.checkHintsAvailable() + +
+          Checks hints section allowed.
+ voidEJDB.close() + +
+          Close database.
+ voidEJDBResultSet.close() + +
+          Close result set
+ voidEJDBCollection.commitTransaction() + +
+          Commit collection transaction.
+ intEJDBQuery.count() + +
+          Convenient count(*) operation
+ intEJDBQuery.count(java.io.OutputStream log) + +
+          Convenient count(*) operation
+ voidEJDBCollection.drop() + +
+          Drop collection.
+ voidEJDBCollection.drop(boolean prune) + +
+          Drop collection.
+ voidEJDBCollection.dropArrayIndex(java.lang.String path) + +
+          Drop index of Array type for BSON field path.
+ voidEJDB.dropCollection(java.lang.String cname) + +
+          Drop collection by name.
+ voidEJDB.dropCollection(java.lang.String cname, + boolean prune) + +
+          Drop collection.
+ voidEJDBCollection.dropIndexes(java.lang.String path) + +
+          Drops indexes of all types for BSON field path.
+ voidEJDBCollection.dropIStringIndex(java.lang.String path) + +
+          Drop case insensitive String index for BSON field path.
+ voidEJDBCollection.dropNumderIndex(java.lang.String path) + +
+          Drop index of Number type for BSON field path.
+ voidEJDBCollection.dropStringIndex(java.lang.String path) + +
+          Drop index of String type for BSON field path.
+ voidEJDBCollection.ensureArrayIndex(java.lang.String path) + +
+          Ensure index presence of Array type for BSON field path
+ EJDBCollectionEJDB.ensureCollection(java.lang.String cname) + +
+          Automatically creates new collection if it does't exists with using default collection options
+ EJDBCollectionEJDB.ensureCollection(java.lang.String cname, + EJDBCollection.Options opts) + +
+          Automatically creates new collection if it does't exists.
+ voidEJDBCollection.ensureExists() + +
+          Automatically creates new collection if it does't exists with using default collection options.
+ voidEJDBCollection.ensureExists(EJDBCollection.Options opts) + +
+          Automatically creates new collection if it does't exists.
+ voidEJDBCollection.ensureIStringIndex(java.lang.String path) + +
+          Ensure case insensitive String index for BSON field path
+ voidEJDBCollection.ensureNumderIndex(java.lang.String path) + +
+          Ensure index presence of Number type for BSON field path
+ voidEJDBCollection.ensureStringIndex(java.lang.String path) + +
+          Ensure index presence of String type for BSON field path
+protected  org.ejdb.driver.EJDBQuery.QResultEJDBQuery.execute(BSONObject query, + BSONObject[] qors, + BSONObject hints, + int flags, + java.io.OutputStream log) + +
+           
+protected  org.ejdb.driver.EJDBQuery.QResultEJDBQuery.execute(BSONObject hints, + int flags, + java.io.OutputStream log) + +
+           
+ EJDBResultSetEJDBQuery.find() + +
+          Execute query
+ EJDBResultSetEJDBQuery.find(java.io.OutputStream log) + +
+          Execute query
+ BSONObjectEJDBQuery.findOne() + +
+          Same as EJDBQuery.find() but retrieves only one matching JSON object.
+ BSONObjectEJDBQuery.findOne(java.io.OutputStream log) + +
+          Same as EJDBQuery.find() but retrieves only one matching JSON object.
+ BSONObjectEJDBResultSet.get(int position) + +
+          Returns object by position
+ EJDBCollectionEJDB.getCollection(java.lang.String cname) + +
+          Returns collection object (without automatical creation)
+ EJDBCollectionEJDB.getCollection(java.lang.String cname, + boolean ecreate) + +
+          Returns collection object
+ EJDBCollectionEJDB.getCollection(java.lang.String cname, + boolean ecreate, + EJDBCollection.Options opts) + +
+          Returns collection object
+ booleanEJDBCollection.isTransactionActive() + +
+          Get collection transaction status.
+ BSONObjectEJDBCollection.load(ObjectId oid) + +
+          Loads BSON object identified by OID from the collection.
+ BSONObjectEJDBResultSet.next() + +
+          
+ voidEJDB.open(java.lang.String path) + +
+          Open database using default open mode.
+ voidEJDB.open(java.lang.String path, + int mode) + +
+          Open database.
+ voidEJDBCollection.optimizeIndexes(java.lang.String path) + +
+          Optimize indexes of all types for BSON field path
+ EJDBQueryBuilderEJDBQueryBuilder.or() + +
+          Add OR joined query restrictions.
+ voidEJDBCollection.rebuildArrayIndex(java.lang.String path) + +
+          Rebuild index of Array type for BSON field path.
+ voidEJDBCollection.rebuildIStringIndex(java.lang.String path) + +
+          Rebuild case insensitive String index for BSON field path.
+ voidEJDBCollection.rebuildNumderIndex(java.lang.String path) + +
+          Rebuild index of Number type for BSON field path.
+ voidEJDBCollection.rebuildStringIndex(java.lang.String path) + +
+          Rebuild index of String type for BSON field path.
+ voidEJDBCollection.remove(ObjectId oid) + +
+          Remove BSON object from collection by OID
+ voidEJDBCollection.rollbackTransaction() + +
+          Abort collection transaction.
+ ObjectIdEJDBCollection.save(BSONObject object) + +
+          Save/update specified BSON object in the collection.
+ java.util.List<ObjectId>EJDBCollection.save(java.util.List<BSONObject> objects) + +
+          Save/update specified BSON objects in the collection.
+protected  voidEJDBCollection.setIndex(java.lang.String path, + int flags) + +
+           
+ voidEJDB.sync() + +
+          Synchronize entire EJDB database and all its collections with storage.
+ voidEJDBCollection.sync() + +
+          Synchronize entire collection with storage.
+protected  booleanEJDBCollection.txControl(int mode) + +
+           
+ intEJDBQuery.update() + +
+          Executes update query
+ intEJDBQuery.update(java.io.OutputStream log) + +
+          Executes update query
+ voidEJDB.updateMeta() + +
+          Update description of EJDB database and its collections.
+ voidEJDBCollection.updateMeta() + +
+          Update collection metainformation from storage
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/driver/class-use/EJDBQuery.html b/jejdb/doc/org/ejdb/driver/class-use/EJDBQuery.html new file mode 100644 index 0000000..9b1b68c --- /dev/null +++ b/jejdb/doc/org/ejdb/driver/class-use/EJDBQuery.html @@ -0,0 +1,217 @@ + + + + + + + +Uses of Class org.ejdb.driver.EJDBQuery (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
org.ejdb.driver.EJDBQuery

+
+ + + + + + + + + +
+Packages that use EJDBQuery
org.ejdb.driver  
+  +

+ + + + + +
+Uses of EJDBQuery in org.ejdb.driver
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in org.ejdb.driver that return EJDBQuery
+ EJDBQueryEJDBCollection.createQuery(BSONObject query) + +
+          Deprecated.  
+ EJDBQueryEJDBCollection.createQuery(BSONObject query, + BSONObject hints) + +
+          Deprecated.  
+ EJDBQueryEJDBCollection.createQuery(BSONObject query, + BSONObject[] qors) + +
+          Deprecated.  
+ EJDBQueryEJDBCollection.createQuery(BSONObject query, + BSONObject[] qors, + BSONObject hints) + +
+          Deprecated.  
+ EJDBQueryEJDBCollection.createQuery(EJDBQueryBuilder query) + +
+          Creates new EJDB Query for current collection.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/driver/class-use/EJDBQueryBuilder.Constraint.html b/jejdb/doc/org/ejdb/driver/class-use/EJDBQueryBuilder.Constraint.html new file mode 100644 index 0000000..0b99c8c --- /dev/null +++ b/jejdb/doc/org/ejdb/driver/class-use/EJDBQueryBuilder.Constraint.html @@ -0,0 +1,228 @@ + + + + + + + +Uses of Class org.ejdb.driver.EJDBQueryBuilder.Constraint (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
org.ejdb.driver.EJDBQueryBuilder.Constraint

+
+ + + + + + + + + +
+Packages that use EJDBQueryBuilder.Constraint
org.ejdb.driver  
+  +

+ + + + + +
+Uses of EJDBQueryBuilder.Constraint in org.ejdb.driver
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in org.ejdb.driver that return EJDBQueryBuilder.Constraint
+ EJDBQueryBuilder.ConstraintEJDBQueryBuilder.field(java.lang.String field) + +
+          Adds constraint for field
+ EJDBQueryBuilder.ConstraintEJDBQueryBuilder.Constraint.field(java.lang.String field) + +
+          Add inner constraint
+ EJDBQueryBuilder.ConstraintEJDBQueryBuilder.Constraint.icase() + +
+          Case insensitive string matching +

+ Example: + query.field(field).icase().eq(value); // -> {field : {$icase : value}} + query.field(field).icase().in(value1, value2); // -> {field : {$icase : {$in : [value1, value2]}}}

+ EJDBQueryBuilder.ConstraintEJDBQueryBuilder.Constraint.not() + +
+          Add $not negatiation constraint +

+ Example: + query.field(field).not().eq(value); // {field : { $not : value }} + query.field(field).not().bt(start, end); // {field : { $not : {$bt : [start, end]}}}

+  +

+ + + + + + + + +
Constructors in org.ejdb.driver with parameters of type EJDBQueryBuilder.Constraint
EJDBQueryBuilder.Constraint(java.lang.String field, + EJDBQueryBuilder.Constraint parent) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/driver/class-use/EJDBQueryBuilder.OrderBy.html b/jejdb/doc/org/ejdb/driver/class-use/EJDBQueryBuilder.OrderBy.html new file mode 100644 index 0000000..94a16c7 --- /dev/null +++ b/jejdb/doc/org/ejdb/driver/class-use/EJDBQueryBuilder.OrderBy.html @@ -0,0 +1,214 @@ + + + + + + + +Uses of Class org.ejdb.driver.EJDBQueryBuilder.OrderBy (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
org.ejdb.driver.EJDBQueryBuilder.OrderBy

+
+ + + + + + + + + +
+Packages that use EJDBQueryBuilder.OrderBy
org.ejdb.driver  
+  +

+ + + + + +
+Uses of EJDBQueryBuilder.OrderBy in org.ejdb.driver
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in org.ejdb.driver that return EJDBQueryBuilder.OrderBy
+ EJDBQueryBuilder.OrderByEJDBQueryBuilder.OrderBy.add(java.lang.String field, + boolean asc) + +
+          Add sorting order for field
+ EJDBQueryBuilder.OrderByEJDBQueryBuilder.OrderBy.asc(java.lang.String field) + +
+          Add ascending sorting order for field
+ EJDBQueryBuilder.OrderByEJDBQueryBuilder.OrderBy.clear() + +
+          Clear all current sorting rules
+ EJDBQueryBuilder.OrderByEJDBQueryBuilder.OrderBy.desc(java.lang.String field) + +
+          Add descinding sorting order for field
+ EJDBQueryBuilder.OrderByEJDBQueryBuilder.orderBy() + +
+          Resturs return sorting rules control object
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/driver/class-use/EJDBQueryBuilder.html b/jejdb/doc/org/ejdb/driver/class-use/EJDBQueryBuilder.html new file mode 100644 index 0000000..7a0ad52 --- /dev/null +++ b/jejdb/doc/org/ejdb/driver/class-use/EJDBQueryBuilder.html @@ -0,0 +1,534 @@ + + + + + + + +Uses of Class org.ejdb.driver.EJDBQueryBuilder (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
org.ejdb.driver.EJDBQueryBuilder

+
+ + + + + + + + + +
+Packages that use EJDBQueryBuilder
org.ejdb.driver  
+  +

+ + + + + +
+Uses of EJDBQueryBuilder in org.ejdb.driver
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in org.ejdb.driver that return EJDBQueryBuilder
+protected  EJDBQueryBuilderEJDBQueryBuilder.addHint(java.lang.String name, + java.lang.Object value) + +
+          Adds pair name->value to hints BSON object.
+protected  EJDBQueryBuilderEJDBQueryBuilder.Constraint.addOperation(java.lang.Object value) + +
+          Add curently restrictons tree to query
+protected  EJDBQueryBuilderEJDBQueryBuilder.addOperation(java.lang.String field, + java.lang.Object value, + boolean replace) + +
+          Adds query restrintions in main query object.
+ EJDBQueryBuilderEJDBQueryBuilder.addToSet(java.lang.String field, + java.lang.Object value) + +
+          Atomically adds value to the array field only if value not in the array already.
+ EJDBQueryBuilderEJDBQueryBuilder.addToSetAll(java.lang.String field, + java.util.Collection<java.lang.Object> values) + +
+          Atomically performs set union with values in val for specified array field.
+ EJDBQueryBuilderEJDBQueryBuilder.addToSetAll(java.lang.String field, + java.lang.Object... values) + +
+          Atomically performs set union with values in val for specified array field.
+ EJDBQueryBuilderEJDBQueryBuilder.Constraint.begin(java.lang.String value) + +
+          Strins starts with prefix
+ EJDBQueryBuilderEJDBQueryBuilder.Constraint.bt(java.lang.Number start, + java.lang.Number end) + +
+          Between number (start <= field_value <= end)
+ EJDBQueryBuilderEJDBQueryBuilder.dropAll() + +
+          In-place record removal operation.
+ EJDBQueryBuilderEJDBQueryBuilder.elementMatch(java.lang.String field) + +
+          Element match construction
+ EJDBQueryBuilderEJDBQueryBuilder.Constraint.eq(java.lang.Object value) + +
+          Field equality restriction.
+ EJDBQueryBuilderEJDBQueryBuilder.excludeField(java.lang.String field) + +
+          Sets fields to be excluded from resulting objects.
+ EJDBQueryBuilderEJDBQueryBuilder.Constraint.exists() + +
+          Field existence matching EJDBQueryBuilder.Constraint.exists(boolean)
+ EJDBQueryBuilderEJDBQueryBuilder.Constraint.exists(boolean exists) + +
+          Field existence matching
+ EJDBQueryBuilderEJDBQueryBuilder.field(java.lang.String field, + java.lang.Object value) + +
+          Adds field equality restriction.
+ EJDBQueryBuilderEJDBQueryBuilder.Constraint.gt(java.lang.Number value) + +
+          Greater than value (field_value > value)
+ EJDBQueryBuilderEJDBQueryBuilder.Constraint.gte(java.lang.Number value) + +
+          Greater than or equal value (field_value >= value)
+ EJDBQueryBuilderEJDBQueryBuilder.Constraint.in(java.util.Collection<java.lang.Object> values) + +
+          Field value matched any value of specified in values.
+ EJDBQueryBuilderEJDBQueryBuilder.Constraint.in(java.lang.Object[] values) + +
+          Field value matched any value of specified in values.
+ EJDBQueryBuilderEJDBQueryBuilder.inc(java.lang.String field, + java.lang.Number inc) + +
+          Increment specified field.
+ EJDBQueryBuilderEJDBQueryBuilder.includeField(java.lang.String field) + +
+          Sets fields to be included in resulting objects.
+ EJDBQueryBuilderEJDBQueryBuilder.join(java.lang.String fpath, + java.lang.String collname) + +
+          Make collection join for select queries.
+ EJDBQueryBuilderEJDBQueryBuilder.Constraint.lt(java.lang.Number value) + +
+          Lesser then value (field_value < value)
+ EJDBQueryBuilderEJDBQueryBuilder.Constraint.lte(java.lang.Number value) + +
+          Lesser then or equal value (field_value <= value)
+ EJDBQueryBuilderEJDBQueryBuilder.Constraint.notIn(java.util.Collection<java.lang.Object> values) + +
+          Negation of EJDBQueryBuilder.Constraint.in(java.util.Collection)
+ EJDBQueryBuilderEJDBQueryBuilder.Constraint.notIn(java.lang.Object[] values) + +
+          Negation of EJDBQueryBuilder.Constraint.in(Object...)
+ EJDBQueryBuilderEJDBQueryBuilder.or() + +
+          Add OR joined query restrictions.
+ EJDBQueryBuilderEJDBQueryBuilder.pull(java.lang.String field, + java.lang.Object value) + +
+          Atomically removes all occurrences of value from field, if field is an array.
+ EJDBQueryBuilderEJDBQueryBuilder.pullAll(java.lang.String field, + java.util.Collection<java.lang.Object> values) + +
+          Atomically performs set substraction of values for specified array field.
+ EJDBQueryBuilderEJDBQueryBuilder.pullAll(java.lang.String field, + java.lang.Object... values) + +
+          Atomically performs set substraction of values for specified array field.
+ EJDBQueryBuilderEJDBQueryBuilder.set(java.lang.String field, + java.lang.Object value) + +
+          Set specified fiels to value +

+ query.set(field1, value1).set(field2, value2); // -> { ..., $set : {field1 : value1, field2 : value2}}

+ EJDBQueryBuilderEJDBQueryBuilder.setFieldIncluded(java.lang.String field, + boolean incldue) + +
+          Sets fields to be included or exluded in resulting objects.
+ EJDBQueryBuilderEJDBQueryBuilder.setMaxResults(int maxResults) + +
+          Sets max number of records in the result set.
+ EJDBQueryBuilderEJDBQueryBuilder.setOffset(int offset) + +
+          Sets number of skipped records in the result set.
+ EJDBQueryBuilderEJDBQueryBuilder.Constraint.strAnd(java.util.Collection<java.lang.String> values) + +
+          String tokens (or string array vals) matches all tokens in specified collection.
+ EJDBQueryBuilderEJDBQueryBuilder.Constraint.strAnd(java.lang.String[] values) + +
+          String tokens (or string array vals) matches all tokens in specified array.
+ EJDBQueryBuilderEJDBQueryBuilder.Constraint.strOr(java.util.Collection<java.lang.String> values) + +
+          String tokens (or string array vals) matches any tokens in specified collection.
+ EJDBQueryBuilderEJDBQueryBuilder.Constraint.strOr(java.lang.String[] values) + +
+          String tokens (or string array vals) matches any tokens in specified array.
+ EJDBQueryBuilderEJDBQueryBuilder.upsert(java.lang.String field, + java.lang.Object value) + +
+          Atomic upsert.
+  +

+ + + + + + + + + +
Methods in org.ejdb.driver with parameters of type EJDBQueryBuilder
+ EJDBQueryEJDBCollection.createQuery(EJDBQueryBuilder query) + +
+          Creates new EJDB Query for current collection.
+  +

+ + + + + + + + +
Constructors in org.ejdb.driver with parameters of type EJDBQueryBuilder
EJDBQueryBuilder(EJDBQueryBuilder parent, + BSONObject query) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/driver/class-use/EJDBResultSet.html b/jejdb/doc/org/ejdb/driver/class-use/EJDBResultSet.html new file mode 100644 index 0000000..90fd66f --- /dev/null +++ b/jejdb/doc/org/ejdb/driver/class-use/EJDBResultSet.html @@ -0,0 +1,189 @@ + + + + + + + +Uses of Class org.ejdb.driver.EJDBResultSet (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
org.ejdb.driver.EJDBResultSet

+
+ + + + + + + + + +
+Packages that use EJDBResultSet
org.ejdb.driver  
+  +

+ + + + + +
+Uses of EJDBResultSet in org.ejdb.driver
+  +

+ + + + + + + + + + + + + +
Methods in org.ejdb.driver that return EJDBResultSet
+ EJDBResultSetEJDBQuery.find() + +
+          Execute query
+ EJDBResultSetEJDBQuery.find(java.io.OutputStream log) + +
+          Execute query
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/driver/package-frame.html b/jejdb/doc/org/ejdb/driver/package-frame.html new file mode 100644 index 0000000..9805256 --- /dev/null +++ b/jejdb/doc/org/ejdb/driver/package-frame.html @@ -0,0 +1,69 @@ + + + + + + + +org.ejdb.driver (JEJDB Doc) + + + + + + + + + + + +org.ejdb.driver + + + + +
+Classes  + +
+BSONQueryObject +
+EJDB +
+EJDBCollection +
+EJDBCollection.Index +
+EJDBCollection.Options +
+EJDBQuery +
+EJDBQueryBuilder +
+EJDBResultSet
+ + + + + + +
+Enums  + +
+EJDBCollection.IndexType
+ + + + + + +
+Exceptions  + +
+EJDBException
+ + + + diff --git a/jejdb/doc/org/ejdb/driver/package-summary.html b/jejdb/doc/org/ejdb/driver/package-summary.html new file mode 100644 index 0000000..f6e292e --- /dev/null +++ b/jejdb/doc/org/ejdb/driver/package-summary.html @@ -0,0 +1,214 @@ + + + + + + + +org.ejdb.driver (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package org.ejdb.driver +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
BSONQueryObjectBSON object for EJDB queries (limitation checks for BSONObject.ID_KEY field)
EJDB 
EJDBCollection 
EJDBCollection.IndexIndex meta information
EJDBCollection.OptionsCollection meta information (and creation options)
EJDBQueryEJDB Query object.
EJDBQueryBuilderQuery/BSON builder is used to create EJDB queries.
EJDBResultSet 
+  + +

+ + + + + + + + + +
+Enum Summary
EJDBCollection.IndexTypeIndex types
+  + +

+ + + + + + + + + +
+Exception Summary
EJDBException 
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/driver/package-tree.html b/jejdb/doc/org/ejdb/driver/package-tree.html new file mode 100644 index 0000000..b002581 --- /dev/null +++ b/jejdb/doc/org/ejdb/driver/package-tree.html @@ -0,0 +1,174 @@ + + + + + + + +org.ejdb.driver Class Hierarchy (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package org.ejdb.driver +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Enum Hierarchy +

+
    +
  • java.lang.Object
      +
    • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
    +
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/org/ejdb/driver/package-use.html b/jejdb/doc/org/ejdb/driver/package-use.html new file mode 100644 index 0000000..ee69d67 --- /dev/null +++ b/jejdb/doc/org/ejdb/driver/package-use.html @@ -0,0 +1,237 @@ + + + + + + + +Uses of Package org.ejdb.driver (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
org.ejdb.driver

+
+ + + + + + + + + +
+Packages that use org.ejdb.driver
org.ejdb.driver  
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Classes in org.ejdb.driver used by org.ejdb.driver
BSONQueryObject + +
+          BSON object for EJDB queries (limitation checks for BSONObject.ID_KEY field)
EJDB + +
+           
EJDBCollection + +
+           
EJDBCollection.Index + +
+          Index meta information
EJDBCollection.IndexType + +
+          Index types
EJDBCollection.Options + +
+          Collection meta information (and creation options)
EJDBException + +
+           
EJDBQuery + +
+          EJDB Query object.
EJDBQueryBuilder + +
+          Query/BSON builder is used to create EJDB queries.
EJDBQueryBuilder.Constraint + +
+          Find constraint for specified field
EJDBQueryBuilder.OrderBy + +
+          Sorting rules for query results
EJDBResultSet + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/overview-frame.html b/jejdb/doc/overview-frame.html new file mode 100644 index 0000000..bae4db7 --- /dev/null +++ b/jejdb/doc/overview-frame.html @@ -0,0 +1,51 @@ + + + + + + + +Overview List (JEJDB Doc) + + + + + + + + + + + + + + + +
+
+ + + + + +
All Classes +

+ +Packages +
+org.ejdb.bson +
+org.ejdb.bson.io +
+org.ejdb.bson.types +
+org.ejdb.bson.util +
+org.ejdb.driver +
+

+ +

+  + + diff --git a/jejdb/doc/overview-summary.html b/jejdb/doc/overview-summary.html new file mode 100644 index 0000000..f6966bf --- /dev/null +++ b/jejdb/doc/overview-summary.html @@ -0,0 +1,168 @@ + + + + + + + +Overview (JEJDB Doc) + + + + + + + + + + + + +


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages
org.ejdb.bson 
org.ejdb.bson.io 
org.ejdb.bson.types 
org.ejdb.bson.util 
org.ejdb.driver 
+ +


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/overview-tree.html b/jejdb/doc/overview-tree.html new file mode 100644 index 0000000..19d6cf5 --- /dev/null +++ b/jejdb/doc/overview-tree.html @@ -0,0 +1,173 @@ + + + + + + + +Class Hierarchy (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For All Packages

+
+
+
Package Hierarchies:
org.ejdb.bson, org.ejdb.bson.io, org.ejdb.bson.types, org.ejdb.bson.util, org.ejdb.driver
+
+

+Class Hierarchy +

+ +

+Enum Hierarchy +

+
    +
  • java.lang.Object
      +
    • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
    +
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/package-list b/jejdb/doc/package-list new file mode 100644 index 0000000..627a002 --- /dev/null +++ b/jejdb/doc/package-list @@ -0,0 +1,5 @@ +org.ejdb.bson +org.ejdb.bson.io +org.ejdb.bson.types +org.ejdb.bson.util +org.ejdb.driver diff --git a/jejdb/doc/resources/inherit.gif b/jejdb/doc/resources/inherit.gif new file mode 100644 index 0000000..c814867 Binary files /dev/null and b/jejdb/doc/resources/inherit.gif differ diff --git a/jejdb/doc/serialized-form.html b/jejdb/doc/serialized-form.html new file mode 100644 index 0000000..c9f7866 --- /dev/null +++ b/jejdb/doc/serialized-form.html @@ -0,0 +1,199 @@ + + + + + + + +Serialized Form (JEJDB Doc) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Serialized Form

+
+
+ + + + + +
+Package org.ejdb.bson
+ +

+ + + + + +
+Class org.ejdb.bson.BSONException extends java.lang.RuntimeException implements Serializable
+ +

+


+ + + + + +
+Package org.ejdb.driver
+ +

+ + + + + +
+Class org.ejdb.driver.EJDBException extends java.lang.RuntimeException implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+code

+
+int code
+
+
+
+
+ +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/jejdb/doc/stylesheet.css b/jejdb/doc/stylesheet.css new file mode 100644 index 0000000..6ea9e51 --- /dev/null +++ b/jejdb/doc/stylesheet.css @@ -0,0 +1,29 @@ +/* Javadoc style sheet */ + +/* Define colors, fonts and other style attributes here to override the defaults */ + +/* Page background color */ +body { background-color: #FFFFFF; color:#000000 } + +/* Headings */ +h1 { font-size: 145% } + +/* Table colors */ +.TableHeadingColor { background: #CCCCFF; color:#000000 } /* Dark mauve */ +.TableSubHeadingColor { background: #EEEEFF; color:#000000 } /* Light mauve */ +.TableRowColor { background: #FFFFFF; color:#000000 } /* White */ + +/* Font used in left-hand frame lists */ +.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } + +/* Navigation bar fonts and colors */ +.NavBarCell1 { background-color:#EEEEFF; color:#000000} /* Light mauve */ +.NavBarCell1Rev { background-color:#00008B; color:#FFFFFF} /* Dark Blue */ +.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;color:#000000;} +.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;color:#FFFFFF;} + +.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} +.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} + diff --git a/jejdb/src/java/org/ejdb/bson/io/InputBuffer.java b/jejdb/src/java/org/ejdb/bson/io/InputBuffer.java index 9690676..c6a60e1 100644 --- a/jejdb/src/java/org/ejdb/bson/io/InputBuffer.java +++ b/jejdb/src/java/org/ejdb/bson/io/InputBuffer.java @@ -6,7 +6,7 @@ import org.ejdb.bson.BSONObject; import java.io.UnsupportedEncodingException; /** - * Utility class for reading BSON object data + * Utility class for reading BSON object data from byte array * * @author Tyutyunkov Vyacheslav (tve@softmotions.com) * @version $Id$