Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- addClassField(String, String, String) - Method in class ai.platon.gora.mongodb.store.MongoMapping
-
Register a new mapping between a field from the persisted class to a MongoDocument field.
- ai.platon.gora.mongodb - package ai.platon.gora.mongodb
-
This package contains MongoDB datastore related all classes.
- ai.platon.gora.mongodb.filters - package ai.platon.gora.mongodb.filters
-
This package contains MongoDB store related util classes.
- ai.platon.gora.mongodb.query - package ai.platon.gora.mongodb.query
-
This package contains all the MongoDB store query representation class as well as Result set representing class when query is executed over the MongoDB dataStore.
- ai.platon.gora.mongodb.store - package ai.platon.gora.mongodb.store
-
This package contains all the MongoDB store related classes.
- ai.platon.gora.mongodb.utils - package ai.platon.gora.mongodb.utils
-
This package contains MongoDB store related util classes.
- appendToBuilder(String, FilterOp, List<Object>) - Method in class ai.platon.gora.mongodb.filters.DefaultFactory
- asDocument() - Method in class ai.platon.gora.mongodb.utils.BSONDecorator
-
Access the decorated
Document.
B
- BaseFactory<K,
T extends ai.platon.gora.persistency.impl.PersistentBase> - Class in ai.platon.gora.mongodb.filters -
Base implementation of a
FilterFactorywhich just manage back reference toMongoFilterUtil. - BaseFactory() - Constructor for class ai.platon.gora.mongodb.filters.BaseFactory
- BINARY - Enum constant in enum class ai.platon.gora.mongodb.store.MongoMapping.DocumentFieldType
- BOOLEAN - Enum constant in enum class ai.platon.gora.mongodb.store.MongoMapping.DocumentFieldType
- BSONDecorator - Class in ai.platon.gora.mongodb.utils
-
Utility class to build
Documentused by MongoDB in an easy way by directly specifying the fully qualified names of fields. - BSONDecorator(Document) - Constructor for class ai.platon.gora.mongodb.utils.BSONDecorator
- build() - Method in class ai.platon.gora.mongodb.store.MongoMappingBuilder
-
Return the built mapping if it is in a legal state
C
- close() - Method in class ai.platon.gora.mongodb.query.MongoDBResult
- close() - Method in class ai.platon.gora.mongodb.store.MongoStore
-
Release the resources linked to this collection
- close() - Method in class ai.platon.gora.mongodb.store.MongoStoreMetadataAnalyzer
- containsField(String) - Method in class ai.platon.gora.mongodb.utils.BSONDecorator
-
Check if the field passed in parameter exists or not.
- createFilter(Filter<K, T>, MongoStore<K, T>) - Method in class ai.platon.gora.mongodb.filters.DefaultFactory
- createFilter(Filter<K, T>, MongoStore<K, T>) - Method in interface ai.platon.gora.mongodb.filters.FilterFactory
- createSchema() - Method in class ai.platon.gora.mongodb.store.MongoStore
-
Create a new collection in MongoDB if necessary.
D
- DATE - Enum constant in enum class ai.platon.gora.mongodb.store.MongoMapping.DocumentFieldType
- decode(BsonReader, DecoderContext) - Method in class ai.platon.gora.mongodb.utils.Utf8Codec
- decodeFieldKey(String) - Method in class ai.platon.gora.mongodb.store.MongoStore
-
Ensure Key decoding -> middle dots replaced with dots
- DEFAULT_MAPPING_FILE - Static variable in class ai.platon.gora.mongodb.store.MongoStore
-
Default value for mapping file
- DefaultFactory<K,
T extends ai.platon.gora.persistency.impl.PersistentBase> - Class in ai.platon.gora.mongodb.filters - DefaultFactory() - Constructor for class ai.platon.gora.mongodb.filters.DefaultFactory
- delete(K) - Method in class ai.platon.gora.mongodb.store.MongoStore
- deleteSchema() - Method in class ai.platon.gora.mongodb.store.MongoStore
-
Drop the collection.
- DOCUMENT - Enum constant in enum class ai.platon.gora.mongodb.store.MongoMapping.DocumentFieldType
- DOUBLE - Enum constant in enum class ai.platon.gora.mongodb.store.MongoMapping.DocumentFieldType
E
- encode(BsonWriter, Utf8, EncoderContext) - Method in class ai.platon.gora.mongodb.utils.Utf8Codec
- encodeFieldKey(String) - Method in class ai.platon.gora.mongodb.store.MongoStore
-
Ensure Key encoding -> dots replaced with middle dots
- equals(Object) - Method in class ai.platon.gora.mongodb.store.MongoMapping
- equals(Object) - Method in class ai.platon.gora.mongodb.store.MongoStoreCollectionMetadata
- executeQuery(Query<K, T>) - Method in class ai.platon.gora.mongodb.store.MongoStore
-
Execute the query and return the result.
- exists(K) - Method in class ai.platon.gora.mongodb.store.MongoStore
F
- FilterFactory<K,
T extends ai.platon.gora.persistency.impl.PersistentBase> - Interface in ai.platon.gora.mongodb.filters -
Describe factory which create remote filter for MongoDB.
- flush() - Method in class ai.platon.gora.mongodb.store.MongoStore
-
Ensure the data is synced to disk.
- fromInputStream(InputStream) - Method in class ai.platon.gora.mongodb.store.MongoMappingBuilder
-
Load the
MongoMappingfrom an input stream passed in parameter.
G
- get(String) - Method in class ai.platon.gora.mongodb.utils.BSONDecorator
-
Access field as an object, no casting.
- get(K, String[]) - Method in class ai.platon.gora.mongodb.store.MongoStore
-
Retrieve an entry from the store with only selected fields.
- getAuthenticationType() - Method in class ai.platon.gora.mongodb.store.MongoStoreParameters
- getBoolean(String) - Method in class ai.platon.gora.mongodb.utils.BSONDecorator
-
Access field as a boolean.
- getBytes(String) - Method in class ai.platon.gora.mongodb.utils.BSONDecorator
-
Access field as bytes.
- getClient(MongoStoreParameters) - Static method in class ai.platon.gora.mongodb.store.MongoStore
-
Retrieve a client connected to the MongoDB server to be used.
- getCollectionName() - Method in class ai.platon.gora.mongodb.store.MongoMapping
-
Getter for the name of the collection
- getDate(String) - Method in class ai.platon.gora.mongodb.utils.BSONDecorator
-
Access field as a date.
- getDBList(String) - Method in class ai.platon.gora.mongodb.utils.BSONDecorator
-
Access field as a collection of
Document. - getDbname() - Method in class ai.platon.gora.mongodb.store.MongoStoreParameters
- getDBObject(String) - Method in class ai.platon.gora.mongodb.utils.BSONDecorator
-
Access field as a
Document. - getDocumentField(String) - Method in class ai.platon.gora.mongodb.store.MongoMapping
-
Given a field from the persistence class, return the corresponding field in the document.
- getDocumentFieldType(String) - Method in class ai.platon.gora.mongodb.store.MongoMapping
-
Package private method to retrieve the type of a document field.
- getDocumentKeys() - Method in class ai.platon.gora.mongodb.store.MongoStoreCollectionMetadata
-
Collection document keys present in a given collection at MongoStore
- getDocumentTypes() - Method in class ai.platon.gora.mongodb.store.MongoStoreCollectionMetadata
-
Collection document types present in a given collection at MongoStore
- getDouble(String) - Method in class ai.platon.gora.mongodb.utils.BSONDecorator
-
Access field as a double.
- getEncoderClass() - Method in class ai.platon.gora.mongodb.utils.Utf8Codec
- getFactory(Filter<K, T>) - Method in class ai.platon.gora.mongodb.filters.MongoFilterUtil
- getFilterUtil() - Method in class ai.platon.gora.mongodb.filters.BaseFactory
- getFilterUtil() - Method in interface ai.platon.gora.mongodb.filters.FilterFactory
- getInt(String) - Method in class ai.platon.gora.mongodb.utils.BSONDecorator
-
Access field as a int.
- getLogin() - Method in class ai.platon.gora.mongodb.store.MongoStoreParameters
- getLong(String) - Method in class ai.platon.gora.mongodb.utils.BSONDecorator
-
Access field as a long.
- getMapping() - Method in class ai.platon.gora.mongodb.store.MongoStore
- getMappingFile() - Method in class ai.platon.gora.mongodb.store.MongoStoreParameters
- getPartitions(Query<K, T>) - Method in class ai.platon.gora.mongodb.store.MongoStore
-
Partitions the given query and returns a list of PartitionQuerys, which will execute on local data.
- getProgress() - Method in class ai.platon.gora.mongodb.query.MongoDBResult
- getReadPreference() - Method in class ai.platon.gora.mongodb.store.MongoStoreParameters
- getSchemaName() - Method in class ai.platon.gora.mongodb.store.MongoStore
-
Accessor to the name of the collection used.
- getSchemaName(String, Class<?>) - Method in class ai.platon.gora.mongodb.store.MongoStore
- getSecret() - Method in class ai.platon.gora.mongodb.store.MongoStoreParameters
- getServers() - Method in class ai.platon.gora.mongodb.store.MongoStoreParameters
- getSupportedFilters() - Method in class ai.platon.gora.mongodb.filters.DefaultFactory
- getSupportedFilters() - Method in interface ai.platon.gora.mongodb.filters.FilterFactory
- getTableInfo(String) - Method in class ai.platon.gora.mongodb.store.MongoStoreMetadataAnalyzer
- getTablesNames() - Method in class ai.platon.gora.mongodb.store.MongoStoreMetadataAnalyzer
- getType() - Method in class ai.platon.gora.mongodb.store.MongoStoreMetadataAnalyzer
- getUtf8String(String) - Method in class ai.platon.gora.mongodb.utils.BSONDecorator
-
Access field as a Utf8 string.
- getWriteConcern() - Method in class ai.platon.gora.mongodb.store.MongoStoreParameters
H
- hashCode() - Method in class ai.platon.gora.mongodb.store.MongoMapping
- hashCode() - Method in class ai.platon.gora.mongodb.store.MongoStoreCollectionMetadata
I
- initialize() - Method in class ai.platon.gora.mongodb.store.MongoStoreMetadataAnalyzer
- initialize(Class<K>, Class<T>, Properties) - Method in class ai.platon.gora.mongodb.store.MongoStore
-
Initialize the data store by reading the credentials, setting the client's properties up and reading the mapping file.
- INT32 - Enum constant in enum class ai.platon.gora.mongodb.store.MongoMapping.DocumentFieldType
- INT64 - Enum constant in enum class ai.platon.gora.mongodb.store.MongoMapping.DocumentFieldType
L
- LIST - Enum constant in enum class ai.platon.gora.mongodb.store.MongoMapping.DocumentFieldType
- load(Properties, Configuration) - Static method in class ai.platon.gora.mongodb.store.MongoStoreParameters
- loadPersistentClass(Element, Class<T>) - Method in class ai.platon.gora.mongodb.store.MongoMappingBuilder
-
Handle the XML parsing of the class definition.
- LOG - Static variable in class ai.platon.gora.mongodb.store.MongoMapping
-
Helper to write useful information into the logs
- LOG - Static variable in class ai.platon.gora.mongodb.store.MongoStore
M
- MONGO_FILTER_FACTORIES_PARAMETER - Static variable in class ai.platon.gora.mongodb.filters.MongoFilterUtil
-
Configuration parameter which allow override of FilterFactory used.
- MONGO_FILTERS_DEFAULT_FACTORY - Static variable in class ai.platon.gora.mongodb.filters.MongoFilterUtil
-
Default implementation class for FilterFactory.
- MongoDBQuery<K,
T extends ai.platon.gora.persistency.impl.PersistentBase> - Class in ai.platon.gora.mongodb.query -
MongoDB specific implementation of the
Queryinterface. - MongoDBQuery() - Constructor for class ai.platon.gora.mongodb.query.MongoDBQuery
- MongoDBQuery(DataStore<K, T>) - Constructor for class ai.platon.gora.mongodb.query.MongoDBQuery
- MongoDBResult<K,
T extends ai.platon.gora.persistency.impl.PersistentBase> - Class in ai.platon.gora.mongodb.query -
MongoDB specific implementation of the
Resultinterface. - MongoDBResult(DataStore<K, T>, Query<K, T>, MongoCursor<Document>, long) - Constructor for class ai.platon.gora.mongodb.query.MongoDBResult
- MongoFilterUtil<K,
T extends ai.platon.gora.persistency.impl.PersistentBase> - Class in ai.platon.gora.mongodb.filters -
Manage creation of filtering
Queryusing configured factories. - MongoFilterUtil(Configuration) - Constructor for class ai.platon.gora.mongodb.filters.MongoFilterUtil
- MongoMapping - Class in ai.platon.gora.mongodb.store
- MongoMapping() - Constructor for class ai.platon.gora.mongodb.store.MongoMapping
- MongoMapping.DocumentFieldType - Enum Class in ai.platon.gora.mongodb.store
-
Accepted types of data to be mapped in mongo based on BSON types
- MongoMappingBuilder<K,
T extends ai.platon.gora.persistency.impl.PersistentBase> - Class in ai.platon.gora.mongodb.store -
A builder for creating the mapper.
- MongoMappingBuilder(MongoStore<K, T>) - Constructor for class ai.platon.gora.mongodb.store.MongoMappingBuilder
- MongoStore<K,
T extends ai.platon.gora.persistency.impl.PersistentBase> - Class in ai.platon.gora.mongodb.store -
Implementation of a MongoDB data store to be used by gora.
- MongoStore() - Constructor for class ai.platon.gora.mongodb.store.MongoStore
- MongoStoreCollectionMetadata - Class in ai.platon.gora.mongodb.store
-
Class with the collection info returned by MongoStoreMetadataAnalyzer with the information about a MongoStore collection.
- MongoStoreCollectionMetadata() - Constructor for class ai.platon.gora.mongodb.store.MongoStoreCollectionMetadata
- MongoStoreMetadataAnalyzer - Class in ai.platon.gora.mongodb.store
- MongoStoreMetadataAnalyzer() - Constructor for class ai.platon.gora.mongodb.store.MongoStoreMetadataAnalyzer
- MongoStoreParameters - Class in ai.platon.gora.mongodb.store
-
Configuration properties
N
- newInstance(Document, String[]) - Method in class ai.platon.gora.mongodb.store.MongoStore
-
Build a new instance of the persisted class from the
Documentretrieved from the database. - newQuery() - Method in class ai.platon.gora.mongodb.store.MongoStore
-
Create a new
Queryto query the datastore. - nextInner() - Method in class ai.platon.gora.mongodb.query.MongoDBResult
O
- OBJECTID - Enum constant in enum class ai.platon.gora.mongodb.store.MongoMapping.DocumentFieldType
P
- PROP_MAPPING_FILE - Static variable in class ai.platon.gora.mongodb.store.MongoStoreParameters
-
Property pointing to the file for the mapping
- PROP_MONGO_AUTHENTICATION_TYPE - Static variable in class ai.platon.gora.mongodb.store.MongoStoreParameters
-
Property pointing to the authentication type to connect to the server
- PROP_MONGO_DB - Static variable in class ai.platon.gora.mongodb.store.MongoStoreParameters
-
Property to select the database
- PROP_MONGO_LOGIN - Static variable in class ai.platon.gora.mongodb.store.MongoStoreParameters
-
Property pointing to the username to connect to the server
- PROP_MONGO_READPREFERENCE - Static variable in class ai.platon.gora.mongodb.store.MongoStoreParameters
-
Property pointing to MongoDB Read Preference value.
- PROP_MONGO_SECRET - Static variable in class ai.platon.gora.mongodb.store.MongoStoreParameters
-
Property pointing to the secret to connect to the server
- PROP_MONGO_SERVERS - Static variable in class ai.platon.gora.mongodb.store.MongoStoreParameters
-
Property pointing to the host where the server is running
- PROP_MONGO_WRITECONCERN - Static variable in class ai.platon.gora.mongodb.store.MongoStoreParameters
-
Property pointing to MongoDB Write Concern value.
- PROP_OVERRIDING - Static variable in class ai.platon.gora.mongodb.store.MongoStoreParameters
-
Property indicating if the hadoop configuration has priority or not
- put(String, Object) - Method in class ai.platon.gora.mongodb.utils.BSONDecorator
-
Set field.
- put(K, T) - Method in class ai.platon.gora.mongodb.store.MongoStore
-
Persist an object into the store.
R
- renameCollection(String, String) - Method in class ai.platon.gora.mongodb.store.MongoMapping
-
Change the name of the collection.
S
- schemaExists() - Method in class ai.platon.gora.mongodb.store.MongoStore
-
Check if the collection already exists or should be created.
- setCollectionName(String) - Method in class ai.platon.gora.mongodb.store.MongoMapping
-
Setter for the name of the collection
- setDocumentKeys(List<String>) - Method in class ai.platon.gora.mongodb.store.MongoStoreCollectionMetadata
- setDocumentTypes(List<String>) - Method in class ai.platon.gora.mongodb.store.MongoStoreCollectionMetadata
- setFilter(Filter<K, T>, MongoStore<K, T>) - Method in class ai.platon.gora.mongodb.filters.MongoFilterUtil
-
Set a filter on the query.
- setFilterUtil(MongoFilterUtil<K, T>) - Method in class ai.platon.gora.mongodb.filters.BaseFactory
- setFilterUtil(MongoFilterUtil<K, T>) - Method in interface ai.platon.gora.mongodb.filters.FilterFactory
- size() - Method in class ai.platon.gora.mongodb.query.MongoDBResult
- STRING - Enum constant in enum class ai.platon.gora.mongodb.store.MongoMapping.DocumentFieldType
T
- toDBQuery(Query<?, ?>) - Static method in class ai.platon.gora.mongodb.query.MongoDBQuery
-
Compute the query itself.
- toProjection(String[], MongoMapping) - Static method in class ai.platon.gora.mongodb.query.MongoDBQuery
-
Compute the projection of the query, that is the fields that will be retrieved from the database.
- toString() - Method in class ai.platon.gora.mongodb.store.MongoStoreCollectionMetadata
- transformFieldFilter(SingleFieldValueFilter<K, T>, MongoStore<K, T>) - Method in class ai.platon.gora.mongodb.filters.DefaultFactory
- transformListFilter(FilterList<K, T>, MongoStore<K, T>) - Method in class ai.platon.gora.mongodb.filters.DefaultFactory
- transformMapFilter(MapFieldValueFilter<K, T>, MongoStore<K, T>) - Method in class ai.platon.gora.mongodb.filters.DefaultFactory
U
- Utf8Codec - Class in ai.platon.gora.mongodb.utils
-
BSON encoder for
Utf8instances. - Utf8Codec() - Constructor for class ai.platon.gora.mongodb.utils.Utf8Codec
V
- valueOf(String) - Static method in enum class ai.platon.gora.mongodb.store.MongoMapping.DocumentFieldType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class ai.platon.gora.mongodb.store.MongoMapping.DocumentFieldType
-
Returns an array containing the constants of this enum class, in the order they are declared.
X
- XML_MAPPING_DEFINITION - Static variable in class ai.platon.gora.mongodb.store.MongoStore
-
Key at DataStore Properties (same as gora.properties) to hold a mapping loaded from memory, instead from filesystem like the one at PARSE_MAPPING_FILE_KEY.
All Classes and Interfaces|All Packages|Constant Field Values