java.lang.Object

com.twicedb.client.api.Indexable

Type Parameters:: I - the type that subclasses Indexable. For example, if class C subclasses Indexable, then `class Foo extends Indexable`

All Implemented Interfaces:: IndexableI

Direct Known Subclasses:: Entitlement

public class Indexable extends Object implements IndexableI

An object that can be indexed. Users may read data only by index or by ObjectId. Therefore, classes that will be queried by field must subclass Indexable.

Field Summary

Fields

Modifier and Type

Field

Description

static final String

CLAZZ_KEY

static final String

FQN_KEY

static final Gson

gson

static final String

REF_RESOLVER_KEY

protected RefResolver

refResolver

protected TypeToken

t
Constructor Summary

Constructors

Constructor

Description

Indexable()
Method Summary

Modifier and Type

Method

Description

final boolean

ensureCanProjectField(String field, ProjectOp op)

final boolean

ensureCanQueryField(String field)

final boolean

equals(Object o)

ObjectId

generateObjectId()

BackfillTt

getBackfillTt()

final Blob

getBlob()

Event

getEvent(Client c)

Future<Event>

getEventAsync(Client c)

Fqn

getFqn(Indexable object)

final IndexedQuery

getIndexedQuery()

final Tt

getLastWrite()

final ObjectId

getObjectId()

final RefResolver

getRefResolver()

final TimesliceId

getTimesliceId()

final Tt

getTtFrom()

final Tt

getTtResolvedAt()

TypeToken

getTypeToken()

final Vt

getVtFrom()

final Vt

getVtResolvedAt()

final int

hashCode()

final void

resetBackfillTt(BackfillTt backfillTt)

final void

setBackfillTt(BackfillTt backfillTt)

final void

setLastWrite(Tt lastWrite)

final void

setObjectId(ObjectId objectId)

void

setRefResolver(RefResolver r)

final void

setTimesliceId(TimesliceId timesliceId)

final void

setTtFrom(Tt ttFrom)

final void

setTtResolvedAt(Tt ttResolvedAt)

final void

setTypeToken(TypeToken t)

final void

setVtFrom(Vt vtFrom)

final void

setVtResolvedAt(Vt vtResolvedAt)

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details
- FQN_KEY
  
  public static final String FQN_KEY
  See Also:
  
  Constant Field Values
- gson
  
  public static final Gson gson
- CLAZZ_KEY
  
  public static final String CLAZZ_KEY
  See Also:
  
  Constant Field Values
- t
  
  protected volatile TypeToken t
- REF_RESOLVER_KEY
  
  public static final String REF_RESOLVER_KEY
  See Also:
  
  Constant Field Values
- refResolver
  
  protected RefResolver refResolver
Constructor Details
- Indexable
  
  public Indexable()
Method Details
- getRefResolver
 
 public final RefResolver getRefResolver()
 
 Specified by:
 
 getRefResolver in interface IndexableI
- setRefResolver
 
 public void setRefResolver(RefResolver r)
- ensureCanProjectField
 
 public final boolean ensureCanProjectField(String field, ProjectOp op)
- ensureCanQueryField
 
 public final boolean ensureCanQueryField(String field)
- getBlob
 
 public final Blob getBlob()
 
 Specified by:
 
 getBlob in interface IndexableI
- getFqn
 
 public Fqn getFqn(Indexable object)
 
 Specified by:
 
 getFqn in interface IndexableI
- getIndexedQuery
 
 public final IndexedQuery getIndexedQuery()
 
 Specified by:
 
 getIndexedQuery in interface IndexableI
- getTypeToken
 
 public TypeToken getTypeToken()
 
 Specified by:
 
 getTypeToken in interface IndexableI
- setTypeToken
 
 public final void setTypeToken(TypeToken t)
- getObjectId
 
 public final ObjectId getObjectId()
 
 Specified by:
 
 getObjectId in interface IndexableI
- generateObjectId
 
 public ObjectId generateObjectId()
- setObjectId
 
 public final void setObjectId(ObjectId objectId)
- getLastWrite
 
 public final Tt getLastWrite()
 
 Specified by:
 
 getLastWrite in interface IndexableI
- setLastWrite
 
 public final void setLastWrite(Tt lastWrite)
- getBackfillTt
 
 public BackfillTt getBackfillTt()
 
 Specified by:
 
 getBackfillTt in interface IndexableI
- setBackfillTt
 
 public final void setBackfillTt(BackfillTt backfillTt)
- resetBackfillTt
 
 public final void resetBackfillTt(BackfillTt backfillTt)
- getTtFrom
 
 public final Tt getTtFrom()
 
 Specified by:
 
 getTtFrom in interface IndexableI
- setTtFrom
 
 public final void setTtFrom(Tt ttFrom)
- getVtFrom
 
 public final Vt getVtFrom()
 
 Specified by:
 
 getVtFrom in interface IndexableI
- setVtFrom
 
 public final void setVtFrom(Vt vtFrom)
- getTtResolvedAt
 
 public final Tt getTtResolvedAt()
- setTtResolvedAt
 
 public final void setTtResolvedAt(Tt ttResolvedAt)
- getVtResolvedAt
 
 public final Vt getVtResolvedAt()
- setVtResolvedAt
 
 public final void setVtResolvedAt(Vt vtResolvedAt)
- getTimesliceId
 
 public final TimesliceId getTimesliceId()
- setTimesliceId
 
 public final void setTimesliceId(TimesliceId timesliceId)
- equals
 
 public final boolean equals(Object o)
 
 Overrides:
 
 equals in class Object
- hashCode
 
 public final int hashCode()
 
 Overrides:
 
 hashCode in class Object
- getEvent
 
 public Event getEvent(Client c)
- getEventAsync
 
 public Future<Event> getEventAsync(Client c)

Class Indexable<I extends Indexable>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

FQN_KEY

gson

CLAZZ_KEY

t

REF_RESOLVER_KEY

refResolver

Constructor Details

Indexable

Method Details

getRefResolver

setRefResolver

ensureCanProjectField

ensureCanQueryField

getBlob

getFqn

getIndexedQuery

getTypeToken

setTypeToken

getObjectId

generateObjectId

setObjectId

getLastWrite

setLastWrite

getBackfillTt

setBackfillTt

resetBackfillTt

getTtFrom

setTtFrom

getVtFrom

setVtFrom

getTtResolvedAt

setTtResolvedAt

getVtResolvedAt

setVtResolvedAt

getTimesliceId

setTimesliceId

equals

hashCode

getEvent

getEventAsync