FilePersisterBase (stallion-core 1.0.0-SNAPSHOT API)

java.lang.Object
- io.stallion.dataAccess.BasePersister<T>
- - io.stallion.dataAccess.file.FilePersisterBase<T>

Type Parameters:

T -

All Implemented Interfaces:

Persister<T>

Direct Known Subclasses:

JsonFilePersister, TextFilePersister, TomlPersister
```
public abstract class FilePersisterBase<T extends Model>
extends BasePersister<T>
```
A base persister that handles retrieving and saving model objects to the file sytem.

Field Summary

Fields
Modifier and Type Field and Description

protected String sortDirection

protected String sortField

Fields
Modifier and Type	Field and Description
`protected String`	`sortDirection`
`protected String`	`sortField`

Constructor Summary

Constructors
Constructor and Description

FilePersisterBase()

Constructors
Constructor and Description
`FilePersisterBase()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`attachWatcher()` Attach any file system watchers for changed objects
`abstract T`	`doFetchOne(File file)`
`List<T>`	`fetchAll()` Fetch all the items from the underlying data store.
`T`	`fetchOne(Long id)` Fetch one object with the given ID
`T`	`fetchOne(String filePath)`
`T`	`fetchOne(T obj)` Re-fetch the passed in object from the underlying data stores
`FilterChain<T>`	`filterChain()`
`String`	`fullFilePathForId(Long id)`
`String`	`fullFilePathForObj(T obj)`
`String`	`getBucketFolderPath()`
`abstract Set<String>`	`getFileExtensions()`
`Map<String,Long>`	`getFileToIdMap()`
`Map<Long,String>`	`getIdToFileMap()`
`String`	`getItemArrayName()`
`void`	`hardDelete(T obj)` Permanently delete the object from the datastore
`void`	`init(DataAccessRegistration registration, ModelController<T> controller, Stash<T> stash)` Initialize the persister, called during DalRegistery.register
`boolean`	`isManyItemsPerFile()`
`Long`	`makeIdFromFilePath(String path)` Derives a Long id by hashing the file path and then taking the first 8 bytes of the path.
`String`	`makePathForObject(T obj)`
`boolean`	`matchesExtension(String path)`
`void`	`onPostLoadFromFile(T obj, String path)`
`String`	`relativeFilePathForObj(T obj)`
`boolean`	`reloadIfNewer(T obj)` Reload the object if the version in the datastore is more recent than the local object
`FilePersisterBase`	`setBucketFolderPath(String bucketFolderPath)`
`FilePersisterBase`	`setFileToIdMap(Map<String,Long> fileToIdMap)`
`FilePersisterBase`	`setIdToFileMap(Map<Long,String> idToFileMap)`
`FilePersisterBase`	`setItemArrayName(String itemArrayName)`
`FilePersisterBase`	`setManyItemsPerFile(boolean manyItemsPerFile)`
`void`	`watchEventCallback(String filePath)` Callback for file-based datastores when an object is changed in the file system

Methods inherited from class io.stallion.dataAccess.BasePersister
getBucket, getItemController, getModelClass, getStash, handleFetchOne, isDbBacked, onFetchOne, onPreRead, setBucket, setItemController, setModelClass, setStash

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

Methods inherited from interface io.stallion.dataAccess.Persister
persist, update

- Field Detail
  - sortField
```
protected String sortField
```
  - sortDirection
```
protected String sortDirection
```
- Constructor Detail
  - FilePersisterBase
```
public FilePersisterBase()
```
- Method Detail
  - init
```
public void init(DataAccessRegistration registration,
                 ModelController<T> controller,
                 Stash<T> stash)
```
    Description copied from interface: Persister
    
    Initialize the persister, called during DalRegistery.register
    
    Specified by:
    
    init in interface Persister<T extends Model>
    
    Overrides:
    
    init in class BasePersister<T extends Model>
  - getFileExtensions
```
public abstract Set<String> getFileExtensions()
```
  - matchesExtension
```
public boolean matchesExtension(String path)
```
  - fetchAll
```
public List<T> fetchAll()
```
    Description copied from interface: Persister
    
    Fetch all the items from the underlying data store.
    
    Returns:
  - fetchOne
```
public T fetchOne(T obj)
```
    Description copied from interface: Persister
    
    Re-fetch the passed in object from the underlying data stores
    
    Returns:
  - fetchOne
```
public T fetchOne(Long id)
```
    Description copied from interface: Persister
    
    Fetch one object with the given ID
    
    Returns:
  - fetchOne
```
public T fetchOne(String filePath)
```
  - doFetchOne
```
public abstract T doFetchOne(File file)
```
  - filterChain
```
public FilterChain<T> filterChain()
```
  - hardDelete
```
public void hardDelete(T obj)
```
    Description copied from interface: Persister
    
    Permanently delete the object from the datastore
  - onPostLoadFromFile
```
public void onPostLoadFromFile(T obj,
                               String path)
```
  - reloadIfNewer
```
public boolean reloadIfNewer(T obj)
```
    Description copied from interface: Persister
    
    Reload the object if the version in the datastore is more recent than the local object
    
    Specified by:
    
    reloadIfNewer in interface Persister<T extends Model>
    
    Overrides:
    
    reloadIfNewer in class BasePersister<T extends Model>
    
    Returns:
  - relativeFilePathForObj
```
public String relativeFilePathForObj(T obj)
```
  - makePathForObject
```
public String makePathForObject(T obj)
```
  - fullFilePathForObj
```
public String fullFilePathForObj(T obj)
```
  - fullFilePathForId
```
public String fullFilePathForId(Long id)
```
  - watchEventCallback
```
public void watchEventCallback(String filePath)
```
    Description copied from interface: Persister
    
    Callback for file-based datastores when an object is changed in the file system
  - attachWatcher
```
public void attachWatcher()
```
    Description copied from interface: Persister
    
    Attach any file system watchers for changed objects
  - makeIdFromFilePath
```
public Long makeIdFromFilePath(String path)
```
    Derives a Long id by hashing the file path and then taking the first 8 bytes of the path. This is used if the model object doesn't have a defined id field.
    
    Parameters:
    
    path -
    
    Returns:
  - getBucketFolderPath
```
public String getBucketFolderPath()
```
  - setBucketFolderPath
```
public FilePersisterBase setBucketFolderPath(String bucketFolderPath)
```
  - getFileToIdMap
```
public Map<String,Long> getFileToIdMap()
```
  - setFileToIdMap
```
public FilePersisterBase setFileToIdMap(Map<String,Long> fileToIdMap)
```
  - getIdToFileMap
```
public Map<Long,String> getIdToFileMap()
```
  - setIdToFileMap
```
public FilePersisterBase setIdToFileMap(Map<Long,String> idToFileMap)
```
  - isManyItemsPerFile
```
public boolean isManyItemsPerFile()
```
  - setManyItemsPerFile
```
public FilePersisterBase setManyItemsPerFile(boolean manyItemsPerFile)
```
  - getItemArrayName
```
public String getItemArrayName()
```
  - setItemArrayName
```
public FilePersisterBase setItemArrayName(String itemArrayName)
```

Class FilePersisterBase<T extends Model>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class io.stallion.dataAccess.BasePersister

Methods inherited from class java.lang.Object

Methods inherited from interface io.stallion.dataAccess.Persister

Field Detail

sortField

sortDirection

Constructor Detail

FilePersisterBase

Method Detail

init

getFileExtensions

matchesExtension

fetchAll

fetchOne

fetchOne

fetchOne

doFetchOne

filterChain

hardDelete

onPostLoadFromFile

reloadIfNewer

relativeFilePathForObj

makePathForObject

fullFilePathForObj

fullFilePathForId

watchEventCallback

attachWatcher

makeIdFromFilePath

getBucketFolderPath

setBucketFolderPath

getFileToIdMap

setFileToIdMap

getIdToFileMap

setIdToFileMap

isManyItemsPerFile

setManyItemsPerFile

getItemArrayName

setItemArrayName