@StableMinor(version="12.1", sinceVersion="8.1") public interface IBigDataRepository extends IBigDataIndexer, IBigDataSearcher
indexer
and
searcher
.IBigDataIndexer
,
IBigDataSearcher
Modifier and Type | Method and Description |
---|---|
void |
addOrUpdateDocumentType(DocumentType documentType)
Deprecated.
since 11.0.0 replaced by
addOrUpdateDocumentType(DocumentType, boolean) .
This call is equivalent to addOrUpdateDocumentType(DocumentType, boolean) passing force true . |
void |
addOrUpdateDocumentType(DocumentType documentType,
boolean force)
Adds or updates a document type into managed indices.
If the managed indices couldn't be updated in underlying big data repository: If force parameter is true , they will be recreated, causing data loss.
Else, an IllegalArgumentException will be raised.
|
void |
deleteDocumentType(String documentTypeId)
Deletes a given document type from managed indices.
|
Object |
getDelegate()
Returns an underlying big data implementation object, if available.
|
DocumentType |
getDocumentType(String documentTypeId)
Returns the document type of the given identifier.
|
DocumentTypeField |
getDocumentTypeField(String documentTypeFieldFullId)
Return the document type field of the field that has the given identifier.
|
Document |
readDocument(DocumentType documentType,
Locale locale,
String documentId)
Reads a document from the repository with the given specifications.
|
IBatchIndexer |
startBatch()
Returns an indexer to perform bulk actions.
The caller must assure IBatchIndexer.close() is called after the desired bulk operations were
performed. |
addDocument, addOrUpdateDocument, deleteDocument, deleteDocumentsByFieldValue, deleteDocumentsByFieldValue, deleteDocumentsByQuery, updateDocumentsByQuerySync
getAutoCompleteSuggestions, search, validate
IBatchIndexer startBatch()
IBatchIndexer.close()
is called after the desired bulk operations were
performed.
Example of usage:
Or using try-with-resources:
@Deprecated void addOrUpdateDocumentType(DocumentType documentType)
addOrUpdateDocumentType(DocumentType, boolean)
.
This call is equivalent to addOrUpdateDocumentType(DocumentType, boolean)
passing force
true
.documentType
- the document type to be added.DocumentTypes
void addOrUpdateDocumentType(DocumentType documentType, boolean force)
force
parameter is true
, they will be recreated, causing data loss.IllegalArgumentException
will be raised.documentType
- the document type to be added.force
- indicates whether the update should be forced.IllegalArgumentException
- if a change in document type is not allowed or the underlying indices couldn't be recreated and force
is false
.DocumentTypes
void deleteDocumentType(String documentTypeId) throws PortalObjectNotFoundException
documentTypeId
- the document type identifier to be deleted.PortalObjectNotFoundException
- if the document type with the given identifier couldn't be found.DocumentType getDocumentType(String documentTypeId) throws PortalObjectNotFoundException
documentTypeId
- the document type identifier.PortalObjectNotFoundException
- if the desired type does not exist.DocumentTypeField getDocumentTypeField(String documentTypeFieldFullId) throws PortalObjectNotFoundException
documentTypeFieldFullId
- the (full) identifier of the document type field.PortalObjectNotFoundException
- if the desired field does not exist.Document readDocument(DocumentType documentType, Locale locale, String documentId) throws PortalObjectNotFoundException
documentType
- the document's type.locale
- the document's locale as set in its standard
locale field. Must be null
if the document does not have a locale specified.documentId
- the document's identifier.PortalObjectNotFoundException
- if no matching document was found.Object getDelegate()
null
.
This method may be used by a repository as a way to expose some extra API to its clients.
LumisXP 12.1.0.191010 - Copyright © 2006–2019 Lumis EIP Tecnologia da Informação LTDA. All Rights Reserved.