DataAccessRegistration (stallion-core 1.0.0-SNAPSHOT API)

java.lang.Object
- io.stallion.dataAccess.DataAccessRegistration

public class DataAccessRegistration
extends Object

Constructor Summary

Constructors
Constructor and Description

DataAccessRegistration()

Constructors
Constructor and Description
`DataAccessRegistration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DataAccessRegistration`	`build(String appTargetPath)` Ensure all required fields are set and valid, hydrate any other fields with defaults.
`String`	`getAbsolutePath()`
`String`	`getBucket()` The bucket is the shorthand by which the controller will be accessed from templates, from DalRegistry.get(), etc.
`Class<? extends ModelController>`	`getControllerClass()`
`DynamicModelDefinition`	`getDynamicModelDefinition()`
`String`	`getItemArrayName()`
`Class<? extends Model>`	`getModelClass()`
`String`	`getNameSpace()`
`String`	`getPath()`
`Class<? extends Persister>`	`getPersisterClass()`
`String`	`getRelativePath()`
`Class<? extends Stash>`	`getStashClass()` The class to use for the data stash.
`String`	`getTableName()`
`String`	`getTemplatePath()`
`void`	`hydratePaths(String appTargetPath)` Parse the target path and hydrate the absolute and relative path fields.
`boolean`	`isDatabaseBacked()`
`boolean`	`isMultiplePerFile()`
`boolean`	`isShouldWatch()`
`boolean`	`isSyncAllToMemory()`
`boolean`	`isUseDataFolder()`
`boolean`	`isWritable()`
`DataAccessRegistration`	`setBucket(String bucket)` The bucket is the shorthand by which the controller will be accessed from templates, from DalRegistry.get(), etc.
`DataAccessRegistration`	`setControllerClass(Class<? extends ModelController> controllerClass)` The ModelController subclass to be associated with this registration
`DataAccessRegistration`	`setDatabaseBacked(boolean databaseBacked)` True if the registration should use the database, false if it should use the file system.
`DataAccessRegistration`	`setDynamicModelDefinition(DynamicModelDefinition dynamicModelDefinition)` Used for defining a model via Javascript
`DataAccessRegistration`	`setItemArrayName(String itemArrayName)` If isMultiplePerFile() is true, this is the name of the array of the objects.
`DataAccessRegistration`	`setModelClass(Class<? extends Model> modelClass)` The data model to be used with this registration
`DataAccessRegistration`	`setMultiplePerFile(boolean multiplePerFile)` True for file-based data stores if there are multiple objects per file, instead of one file per object
`DataAccessRegistration`	`setNameSpace(String nameSpace)`
`DataAccessRegistration`	`setPath(String path)` For file based registrations, the path to the folder with the data.
`DataAccessRegistration`	`setPersisterClass(Class<? extends Persister> persisterClass)` The Persister subclass to use for this registration
`DataAccessRegistration`	`setShouldWatch(boolean shouldWatch)` Should the file system be watched for changes, and reload changes automatically?
`DataAccessRegistration`	`setStashClass(Class<? extends Stash> stashClass)`
`DataAccessRegistration`	`setSyncAllToMemory(boolean syncAllToMemory)` Should all objects from the data store be synced to local memory? Defaults to true.
`DataAccessRegistration`	`setTableName(String tableName)` The database table for the data, for DB backed registrations
`DataAccessRegistration`	`setTemplatePath(String templatePath)` For displayable registrations, the default template to use for rendering the object.
`DataAccessRegistration`	`setUseDataFolder(boolean useDataFolder)` If true, relative path will be relative to the app-data folder, not the project folder.
`DataAccessRegistration`	`setWritable(boolean writable)` Is Stallion allowed to write to the datastore, or is it read only?

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

- Constructor Detail
  - DataAccessRegistration
```
public DataAccessRegistration()
```
- Method Detail
  - build
```
public DataAccessRegistration build(String appTargetPath)
```
    Ensure all required fields are set and valid, hydrate any other fields with defaults.
    
    Parameters:
    
    appTargetPath -
    
    Returns:
  - hydratePaths
```
public void hydratePaths(String appTargetPath)
```
    Parse the target path and hydrate the absolute and relative path fields.
    
    Parameters:
    
    appTargetPath -
  - getControllerClass
```
public Class<? extends ModelController> getControllerClass()
```
  - setControllerClass
```
public DataAccessRegistration setControllerClass(Class<? extends ModelController> controllerClass)
```
    The ModelController subclass to be associated with this registration
    
    Returns:
  - getModelClass
```
public Class<? extends Model> getModelClass()
```
  - setModelClass
```
public DataAccessRegistration setModelClass(Class<? extends Model> modelClass)
```
    The data model to be used with this registration
    
    Returns:
  - getPath
```
public String getPath()
```
  - setPath
```
public DataAccessRegistration setPath(String path)
```
    For file based registrations, the path to the folder with the data. Should be relative.
    
    Returns:
  - getRelativePath
```
public String getRelativePath()
```
  - getAbsolutePath
```
public String getAbsolutePath()
```
  - getTableName
```
public String getTableName()
```
  - setTableName
```
public DataAccessRegistration setTableName(String tableName)
```
    The database table for the data, for DB backed registrations
    
    Returns:
  - getPersisterClass
```
public Class<? extends Persister> getPersisterClass()
```
  - setPersisterClass
```
public DataAccessRegistration setPersisterClass(Class<? extends Persister> persisterClass)
```
    The Persister subclass to use for this registration
    
    Returns:
  - isWritable
```
public boolean isWritable()
```
  - setWritable
```
public DataAccessRegistration setWritable(boolean writable)
```
    Is Stallion allowed to write to the datastore, or is it read only?
    
    Parameters:
    
    writable -
    
    Returns:
  - isShouldWatch
```
public boolean isShouldWatch()
```
  - setShouldWatch
```
public DataAccessRegistration setShouldWatch(boolean shouldWatch)
```
    Should the file system be watched for changes, and reload changes automatically?
    
    Returns:
  - getNameSpace
```
public String getNameSpace()
```
  - setNameSpace
```
public DataAccessRegistration setNameSpace(String nameSpace)
```
  - getBucket
```
public String getBucket()
```
    The bucket is the shorthand by which the controller will be accessed from templates, from DalRegistry.get(), etc. Usually this should be the table name or the folder name, but you can set it to a custom value. It should be unique among all registrations.
    
    Returns:
  - getTemplatePath
```
public String getTemplatePath()
```
  - setTemplatePath
```
public DataAccessRegistration setTemplatePath(String templatePath)
```
    For displayable registrations, the default template to use for rendering the object.
    
    Returns:
  - isUseDataFolder
```
public boolean isUseDataFolder()
```
  - setUseDataFolder
```
public DataAccessRegistration setUseDataFolder(boolean useDataFolder)
```
    If true, relative path will be relative to the app-data folder, not the project folder.
    
    Parameters:
    
    useDataFolder -
    
    Returns:
  - setBucket
```
public DataAccessRegistration setBucket(String bucket)
```
    The bucket is the shorthand by which the controller will be accessed from templates, from DalRegistry.get(), etc. Usually this should be the table name or the folder name, but you can set it to a custom value. It should be unique among all registrations.
    
    Returns:
  - getDynamicModelDefinition
```
public DynamicModelDefinition getDynamicModelDefinition()
```
  - setDynamicModelDefinition
```
public DataAccessRegistration setDynamicModelDefinition(DynamicModelDefinition dynamicModelDefinition)
```
    Used for defining a model via Javascript
    
    Parameters:
    
    dynamicModelDefinition -
    
    Returns:
  - isMultiplePerFile
```
public boolean isMultiplePerFile()
```
  - setMultiplePerFile
```
public DataAccessRegistration setMultiplePerFile(boolean multiplePerFile)
```
    True for file-based data stores if there are multiple objects per file, instead of one file per object
    
    Returns:
  - getItemArrayName
```
public String getItemArrayName()
```
  - setItemArrayName
```
public DataAccessRegistration setItemArrayName(String itemArrayName)
```
    If isMultiplePerFile() is true, this is the name of the array of the objects.
    
    Parameters:
    
    itemArrayName -
    
    Returns:
  - getStashClass
```
public Class<? extends Stash> getStashClass()
```
    The class to use for the data stash. Default is LocalMemoryStash, which syncs everything into local memory. Use NoStash to avoid syncing into memory.
    
    Returns:
  - setStashClass
```
public DataAccessRegistration setStashClass(Class<? extends Stash> stashClass)
```
  - isSyncAllToMemory
```
public boolean isSyncAllToMemory()
```
  - setSyncAllToMemory
```
public DataAccessRegistration setSyncAllToMemory(boolean syncAllToMemory)
```
    Should all objects from the data store be synced to local memory? Defaults to true.
    
    Returns:
  - isDatabaseBacked
```
public boolean isDatabaseBacked()
```
  - setDatabaseBacked
```
public DataAccessRegistration setDatabaseBacked(boolean databaseBacked)
```
    True if the registration should use the database, false if it should use the file system.
    
    Parameters:
    
    databaseBacked -
    
    Returns:

Class DataAccessRegistration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DataAccessRegistration

Method Detail

build

hydratePaths

getControllerClass

setControllerClass

getModelClass

setModelClass

getPath

setPath

getRelativePath

getAbsolutePath

getTableName

setTableName

getPersisterClass

setPersisterClass

isWritable

setWritable

isShouldWatch

setShouldWatch

getNameSpace

setNameSpace

getBucket

getTemplatePath

setTemplatePath

isUseDataFolder

setUseDataFolder

setBucket

getDynamicModelDefinition

setDynamicModelDefinition

isMultiplePerFile

setMultiplePerFile

getItemArrayName

setItemArrayName

getStashClass

setStashClass

isSyncAllToMemory

setSyncAllToMemory

isDatabaseBacked

setDatabaseBacked