com.indexdata.torus2.rw.impl

Class RealmFileRW

java.lang.Object

com.indexdata.torus2.rw.impl.RealmFileRW

All Implemented Interfaces:

RealmReaderWriter

public class RealmFileRW
extends Object
implements RealmReaderWriter

Flat, multi-file implementation of the record store

Author:

jakub

Constructor Summary

Constructors

Constructor and Description
RealmFileRW(String realmName, String basePath) Opens RW on a specified realm.

Method Summary

Modifier and Type	Method and Description
boolean	create(RealmDefinition rd) Creates a new new realm store.
void	deleteCachedAsOriginal(String id)
void	deleteMasterRecord(String unsanitizedId)
void	deleteOverrideRecord(String unsanitizedId)
void	deleteParentRealm(String unsanitizedId)
void	deleteWorldRecordsByParentId(String prId)
RealmDefinition	describe() Retrieves RealmDefinition for the given realm.
void	destroy() Destroys the underlying record store;
Object	getLock(String host)
boolean	isCachedAsParent() In case the realm serves as parent to other realms within the same torus installation, the following function allows for fast propagation of changes to child realms.
List<RealmDefinition>	listRealms() List all realms available within the torus.
List<RealmReaderWriter>	listRWs(boolean open)
boolean	open() Attempts to open the realm store pointed to by this instance.
Record.Layer	readMasterRecord(String unsanitizedId)
List<Record.Layer>	readMasterRecords()
Record.Layer	readOverrideRecord(String unsanitizedId) Retrieve override record by id.
List<Record.Layer>	readOverrideRecords() Retrieve a list of override records within this realm, the query parameter is used ONLY to early filter out false matches, that is records that CONTAIN a given query field but the value DOES NOT match.
ParentRealm	readParentRealm(String unsanitizedId)
List<ParentRealm>	readParentRealms()
Record.Layer	readWorldRecord(String id) Retrieve world (within a set of parents) record by id.
Pair<List<Record.Layer>,Date>	readWorldRecordsForParent(String prId) Retrieve a time-stamped list of records for a parent specified within this realm,
boolean	update(RealmDefinition rd) Updates realm meta-data.
Record.Layer	updateCachedAsOriginal(Record.Layer original)
Record.Layer	writeMasterRecord(Record.Layer masterLayer)
Record.Layer	writeMasterRecord(String unsanitizedId, Record.Layer update)
Record.Layer	writeOverrideRecord(Record.Layer override) The method is to write new record to the record store.
Record.Layer	writeOverrideRecord(String unsanitizedId, Record.Layer update) Write data to the existing record.
ParentRealm	writeParentRealm(ParentRealm pr)
ParentRealm	writeParentRealm(String unsanitizedId, ParentRealm pr)
List<Record.Layer>	writeWorldRecordsForParent(List<Record.Layer> doc, String prId) Stores parent records for the given parent, updates each world record with an ID unique to this realm (so world records can be looked up without specifying parent)
List<Record.Layer>	writeWorldRecordsForParent(List<Record.Layer> doc, String prId, Date timestamp)

Methods inherited from class java.lang.Object

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

Constructor Detail

RealmFileRW

public RealmFileRW(String realmName,
                   String basePath)

Opens RW on a specified realm. It's possible to set 'realm' argument to null in which case the RW will remain closed but will allow certain operation (e.g listRealms)

Parameters:

realmName -

basePath -

Method Detail

getLock

public Object getLock(String host)

create

public boolean create(RealmDefinition rd)
               throws InternalIOException

Description copied from interface: RealmReaderWriter

Creates a new new realm store. Returns true if the realm store has been properly created or false if the realm store already exists.

Specified by:

create in interface RealmReaderWriter

Throws:

InternalIOException - when creation failed

update

public boolean update(RealmDefinition rd)
               throws InternalIOException

Description copied from interface: RealmReaderWriter

Updates realm meta-data. Returns false when the realm does not exist.

Specified by:

update in interface RealmReaderWriter

Returns:

Throws:

InternalIOException

open

public boolean open()
             throws InternalIOException

Description copied from interface: RealmReaderWriter

Attempts to open the realm store pointed to by this instance. Returns true if the realm has been properly opened or false if the realm has already been opened (e.g on consecutive calls)

Specified by:

open in interface RealmReaderWriter

Returns:

Throws:

InternalIOException

describe

public RealmDefinition describe()

Description copied from interface: RealmReaderWriter

Retrieves RealmDefinition for the given realm.

Specified by:

describe in interface RealmReaderWriter

Returns:

destroy

public void destroy()
             throws InternalIOException

Description copied from interface: RealmReaderWriter

Destroys the underlying record store;

Specified by:

destroy in interface RealmReaderWriter

Throws:

InternalIOException

readOverrideRecords

public List<Record.Layer> readOverrideRecords()
                                       throws InternalIOException

Description copied from interface: RealmReaderWriter

Retrieve a list of override records within this realm, the query parameter is used ONLY to early filter out false matches, that is records that CONTAIN a given query field but the value DOES NOT match.

Specified by:

readOverrideRecords in interface RealmReaderWriter

Returns:

list (possibly empty e.g when realm contains no records) of records

Throws:

InternalIOException - when experiencing problems reading/parsing records

readOverrideRecord

public Record.Layer readOverrideRecord(String unsanitizedId)
                                throws InternalIOException

Description copied from interface: RealmReaderWriter

Retrieve override record by id.

Specified by:

readOverrideRecord in interface RealmReaderWriter

Parameters:

unsanitizedId - override record id

Returns:

found record

Throws:

InternalIOException - when experiencing problems reading/parsing records

writeOverrideRecord

public Record.Layer writeOverrideRecord(String unsanitizedId,
                                        Record.Layer update)
                                 throws InternalIOException

Description copied from interface: RealmReaderWriter

Write data to the existing record. This method does not merge anything, it simply override the existing record.

Specified by:

writeOverrideRecord in interface RealmReaderWriter

Parameters:

unsanitizedId - id of the records

Returns:

written contents doc, possibly with additional fields

Throws:

InternalIOException

writeOverrideRecord

public Record.Layer writeOverrideRecord(Record.Layer override)
                                 throws InternalIOException

Description copied from interface: RealmReaderWriter

The method is to write new record to the record store.

Specified by:

writeOverrideRecord in interface RealmReaderWriter

Returns:

written contents doc, with additional fields (e.g id)

Throws:

InternalIOException

deleteOverrideRecord

public void deleteOverrideRecord(String unsanitizedId)
                          throws InternalIOException

Specified by:

deleteOverrideRecord in interface RealmReaderWriter

Throws:

InternalIOException

readWorldRecordsForParent

public Pair<List<Record.Layer>,Date> readWorldRecordsForParent(String prId)
                                                        throws InternalIOException

Description copied from interface: RealmReaderWriter

Retrieve a time-stamped list of records for a parent specified within this realm,

Specified by:

readWorldRecordsForParent in interface RealmReaderWriter

Returns:

list (possibly empty, e.g when world contains no records) of records

Throws:

InternalIOException - when experiencing problems reading/parsing records

readWorldRecord

public Record.Layer readWorldRecord(String id)
                             throws InternalIOException

Description copied from interface: RealmReaderWriter

Retrieve world (within a set of parents) record by id.

Specified by:

readWorldRecord in interface RealmReaderWriter

Returns:

found record

Throws:

InternalIOException - when experiencing problems reading/parsing records

writeWorldRecordsForParent

public List<Record.Layer> writeWorldRecordsForParent(List<Record.Layer> doc,
                                                     String prId)
                                              throws InternalIOException

Description copied from interface: RealmReaderWriter

Stores parent records for the given parent, updates each world record with an ID unique to this realm (so world records can be looked up without specifying parent)

Specified by:

writeWorldRecordsForParent in interface RealmReaderWriter

Returns:

Throws:

InternalIOException

writeWorldRecordsForParent

public List<Record.Layer> writeWorldRecordsForParent(List<Record.Layer> doc,
                                                     String prId,
                                                     Date timestamp)
                                              throws InternalIOException

Specified by:

writeWorldRecordsForParent in interface RealmReaderWriter

Throws:

InternalIOException

deleteWorldRecordsByParentId

public void deleteWorldRecordsByParentId(String prId)
                                  throws InternalIOException

Specified by:

deleteWorldRecordsByParentId in interface RealmReaderWriter

Throws:

InternalIOException

writeParentRealm

public ParentRealm writeParentRealm(String unsanitizedId,
                                    ParentRealm pr)
                             throws InternalIOException

Specified by:

writeParentRealm in interface RealmReaderWriter

Throws:

InternalIOException

writeParentRealm

public ParentRealm writeParentRealm(ParentRealm pr)
                             throws InternalIOException

Specified by:

writeParentRealm in interface RealmReaderWriter

Throws:

InternalIOException

readParentRealm

public ParentRealm readParentRealm(String unsanitizedId)
                            throws InternalIOException

Specified by:

readParentRealm in interface RealmReaderWriter

Throws:

InternalIOException

deleteParentRealm

public void deleteParentRealm(String unsanitizedId)
                       throws InternalIOException

Specified by:

deleteParentRealm in interface RealmReaderWriter

Throws:

InternalIOException

readParentRealms

public List<ParentRealm> readParentRealms()
                                   throws InternalIOException

Specified by:

readParentRealms in interface RealmReaderWriter

Throws:

InternalIOException

listRWs

public List<RealmReaderWriter> listRWs(boolean open)
                                throws InternalIOException

Throws:

InternalIOException

listRealms

public List<RealmDefinition> listRealms()
                                 throws InternalIOException

Description copied from interface: RealmReaderWriter

List all realms available within the torus. This method feels welted on here, but introducing tree hierarchy would complicate third-party implementations.

Specified by:

listRealms in interface RealmReaderWriter

Returns:

Throws:

InternalIOException

isCachedAsParent

public boolean isCachedAsParent()
                         throws InternalIOException

Description copied from interface: RealmReaderWriter

In case the realm serves as parent to other realms within the same torus installation, the following function allows for fast propagation of changes to child realms.

Specified by:

isCachedAsParent in interface RealmReaderWriter

Throws:

InternalIOException

updateCachedAsOriginal

public Record.Layer updateCachedAsOriginal(Record.Layer original)
                                    throws InternalIOException

Specified by:

updateCachedAsOriginal in interface RealmReaderWriter

Throws:

InternalIOException

deleteCachedAsOriginal

public void deleteCachedAsOriginal(String id)
                            throws InternalIOException

Specified by:

deleteCachedAsOriginal in interface RealmReaderWriter

Throws:

InternalIOException

readMasterRecords

public List<Record.Layer> readMasterRecords()
                                     throws InternalIOException

Specified by:

readMasterRecords in interface RealmReaderWriter

Throws:

InternalIOException

readMasterRecord

public Record.Layer readMasterRecord(String unsanitizedId)
                              throws InternalIOException

Specified by:

readMasterRecord in interface RealmReaderWriter

Throws:

InternalIOException

writeMasterRecord

public Record.Layer writeMasterRecord(String unsanitizedId,
                                      Record.Layer update)
                               throws InternalIOException

Specified by:

writeMasterRecord in interface RealmReaderWriter

Throws:

InternalIOException

writeMasterRecord

public Record.Layer writeMasterRecord(Record.Layer masterLayer)
                               throws InternalIOException

Specified by:

writeMasterRecord in interface RealmReaderWriter

Throws:

InternalIOException

deleteMasterRecord

public void deleteMasterRecord(String unsanitizedId)
                        throws InternalIOException

Specified by:

deleteMasterRecord in interface RealmReaderWriter

Throws:

InternalIOException