TxCache (grakn-kb 1.3.0 API)

java.lang.Object
- ai.grakn.kb.internal.cache.TxCache

```
public class TxCache
extends Object
```
Tracks Transaction Specific Variables

Caches Transaction specific data this includes:
1. Validation Concepts - Concepts which need to undergo validation.
2. Built Concepts - Prevents rebuilding when the same vertex is encountered
3. The Schema - Optimises validation checks by preventing db read.
4. Label - Allows mapping type labels to type Ids
5. Transaction meta Data - Allows transactions to function in different ways
Author:

fppt

Constructor Summary

Constructors
Constructor and Description

TxCache(GlobalCache globalCache)

Constructors
Constructor and Description
`TxCache(GlobalCache globalCache)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addedInstance(ConceptId conceptId)`
`void`	`addNewAttribute(String index, ConceptId conceptId)`
`void`	`addNewRelationship(Relationship relationship)`
`void`	`cacheConcept(Concept concept)` Caches a concept so it does not have to be rebuilt later.
`void`	`closeTx(String closedReason)`
`LabelId`	`convertLabelToId(Label label)`
`<X extends Concept> X`	`getCachedConcept(ConceptId id)` Returns a previously built concept
`<X extends SchemaConcept> X`	`getCachedSchemaConcept(Label label)` Returns a previously built type
`String`	`getClosedReason()`
`Set<Casting>`	`getModifiedCastings()`
`Set<RelationshipType>`	`getModifiedRelationshipTypes()`
`Set<Role>`	`getModifiedRoles()`
`Set<Rule>`	`getModifiedRules()`
`Set<Thing>`	`getModifiedThings()`
`Map<String,ConceptId>`	`getNewAttributes()`
`Set<Relationship>`	`getNewRelationships()`
`Map<ConceptId,Long>`	`getShardingCount()`
`boolean`	`isConceptCached(ConceptId id)` Checks if the concept has been built before and is currently cached
`boolean`	`isLabelCached(Label label)`
`boolean`	`isTxOpen()`
`boolean`	`isTypeCached(Label label)`
`void`	`openTx(GraknTxType txType)`
`void`	`refreshSchemaCache()` Refreshes the transaction schema cache by reading the central schema cache is read into this transaction cache.
`void`	`remove(Casting casting)`
`void`	`remove(Concept concept)`
`void`	`removedInstance(ConceptId conceptId)`
`void`	`removeFromValidation(Type type)`
`boolean`	`schemaNotCached()`
`void`	`trackForValidation(Casting casting)`
`void`	`trackForValidation(Concept concept)`
`GraknTxType`	`txType()`
`void`	`writeOccurred()` Notifies the cache that a write has occurred.
`void`	`writeToGraphCache(boolean isSafe)` A helper method which writes back into the graph cache at the end of a transaction.

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

- Constructor Detail
  - TxCache
```
public TxCache(GlobalCache globalCache)
```
- Method Detail
  - writeToGraphCache
```
public void writeToGraphCache(boolean isSafe)
```
    A helper method which writes back into the graph cache at the end of a transaction.
    
    Parameters:
    
    isSafe - true only if it is safe to copy the cache completely without any checks
  - writeOccurred
```
public void writeOccurred()
```
    Notifies the cache that a write has occurred. This is later used to determine if it is safe to flush the transaction cache to the session cache or not.
  - schemaNotCached
```
public boolean schemaNotCached()
```
    Returns:
    
    true if ths schema labels have been cached. The graph cannot operate if this is false.
  - refreshSchemaCache
```
public void refreshSchemaCache()
```
    Refreshes the transaction schema cache by reading the central schema cache is read into this transaction cache. This method performs this operation whilst making a deep clone of the cached concepts to ensure transactions do not accidentally break the central schema cache.
  - trackForValidation
```
public void trackForValidation(Concept concept)
```
    Parameters:
    
    concept - The element to be later validated
  - trackForValidation
```
public void trackForValidation(Casting casting)
```
  - removeFromValidation
```
public void removeFromValidation(Type type)
```
  - getShardingCount
```
public Map<ConceptId,Long> getShardingCount()
```
    Returns:
    
    All the types that have gained or lost instances and by how much
  - remove
```
public void remove(Concept concept)
```
    Parameters:
    
    concept - The concept to no longer track
  - remove
```
public void remove(Casting casting)
```
  - cacheConcept
```
public void cacheConcept(Concept concept)
```
    Caches a concept so it does not have to be rebuilt later.
    
    Parameters:
    
    concept - The concept to be cached.
  - isConceptCached
```
public boolean isConceptCached(ConceptId id)
```
    Checks if the concept has been built before and is currently cached
    
    Parameters:
    
    id - The id of the concept
    
    Returns:
    
    true if the concept is cached
  - isTypeCached
```
public boolean isTypeCached(Label label)
```
    Parameters:
    
    label - The label of the type to cache
    
    Returns:
    
    true if the concept is cached
  - isLabelCached
```
public boolean isLabelCached(Label label)
```
    Parameters:
    
    label - the type label which may be in the cache
    
    Returns:
    
    true if the label is cached and has a valid mapping to a id
  - getCachedConcept
```
public <X extends Concept> X getCachedConcept(ConceptId id)
```
    Returns a previously built concept
    
    Type Parameters:
    
    X - The type of the concept
    
    Parameters:
    
    id - The id of the concept
    
    Returns:
    
    The cached concept
  - getCachedSchemaConcept
```
public <X extends SchemaConcept> X getCachedSchemaConcept(Label label)
```
    Returns a previously built type
    
    Type Parameters:
    
    X - The type of the type
    
    Parameters:
    
    label - The label of the type
    
    Returns:
    
    The cached type
  - convertLabelToId
```
public LabelId convertLabelToId(Label label)
```
  - addedInstance
```
public void addedInstance(ConceptId conceptId)
```
  - removedInstance
```
public void removedInstance(ConceptId conceptId)
```
  - addNewAttribute
```
public void addNewAttribute(String index,
                            ConceptId conceptId)
```
  - getNewAttributes
```
public Map<String,ConceptId> getNewAttributes()
```
  - getModifiedThings
```
public Set<Thing> getModifiedThings()
```
  - getModifiedRoles
```
public Set<Role> getModifiedRoles()
```
  - getModifiedRelationshipTypes
```
public Set<RelationshipType> getModifiedRelationshipTypes()
```
  - getModifiedRules
```
public Set<Rule> getModifiedRules()
```
  - getModifiedCastings
```
public Set<Casting> getModifiedCastings()
```
  - addNewRelationship
```
public void addNewRelationship(Relationship relationship)
```
  - getNewRelationships
```
public Set<Relationship> getNewRelationships()
```
  - closeTx
```
public void closeTx(String closedReason)
```
  - openTx
```
public void openTx(GraknTxType txType)
```
  - isTxOpen
```
public boolean isTxOpen()
```
  - txType
```
public GraknTxType txType()
```
  - getClosedReason
```
public String getClosedReason()
```

Class TxCache

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TxCache

Method Detail

writeToGraphCache

writeOccurred

schemaNotCached

refreshSchemaCache

trackForValidation

trackForValidation

removeFromValidation

getShardingCount

remove

remove

cacheConcept

isConceptCached

isTypeCached

isLabelCached

getCachedConcept

getCachedSchemaConcept

convertLabelToId

addedInstance

removedInstance

addNewAttribute

getNewAttributes

getModifiedThings

getModifiedRoles

getModifiedRelationshipTypes

getModifiedRules

getModifiedCastings

addNewRelationship

getNewRelationships

closeTx

openTx

isTxOpen

txType

getClosedReason