persistence

type FilePersistence ¶

type FilePersistence struct {
	MemoryPersistence
	Persister *JsonFilePersister
}

Abstract persistence component that stores data in flat files and caches them in memory.

FilePersistence is the most basic persistence component that is only able to store data items of any type. Specific CRUD operations over the data items must be implemented in child structs by accessing fp._items property and calling Save method.

see MemoryPersistence see JsonFilePersister

Configuration parameters ¶

- path - path to the file where data is stored

References ¶

- *:logger:*:*:1.0 (optional) ILogger components to pass log messages

Example

type MyJsonFilePersistence struct {
	FilePersistence
}

    func NewMyJsonFilePersistence(path string) *NewMyJsonFilePersistence {
		prototype := reflcet.TypeOf(MyData{})
		return &NewFilePersistence(prototype, NewJsonPersister(prototype, path))
    }

	func (c * FilePersistence) GetByName(correlationId string, name string) (item MyData, err error){
		for _,v := range c._items {
			if v.Name == name {
				item = v.(MyData)
				break
			}
		}
        return item, nil
    }

    func (c *FilePersistence) Set(correlatonId string, item MyData) error {
		for i,v := range c._items {
			if v.name == item.name {
				c._items = append(c._items[:i], c._items[i+1:])
			}
		}
		c._items = append(c._items, item)
        retrun c.save(correlationId)
    }
}

extends MemoryPersistence implements IConfigurable

func NewFilePersistence(prototype reflect.Type, persister *JsonFilePersister) *FilePersistence

func (c *FilePersistence) Configure(conf config.ConfigParams)

type IFilteredPageReader ¶

type IFilteredPageReader interface {

	// Gets a page of data items using filter
	// Parameters
	//   	- correlation_id
	//		transaction id to trace execution through call chain.
	//   	- filter  data.FilterParams
	//		filter parameters
	//   	- paging data.PagingParams
	//      paging parameters
	//   	- sort data.SortParams
	//      sort parameters
	// Retrun  interface{}, error
	// list of items or error.
	GetPageByFilter(correlation_id string, filter data.FilterParams, paging data.PagingParams, sort data.SortParams) (page interface{}, err error)
}

IFilteredPageReader is interface for data processing components that can retrieve a page of data items by a filter.

type IFilteredReader ¶

type IFilteredReader interface {

	// Gets a list of data items using filter
	// Parameters:
	// 			- correlation_id string
	//		    transaction id to trace execution through call chain.
	// 			- filter data.FilterParams
	//          filter parameters
	// 			- sort  data.SortParams
	//			sort parameters
	// Returns []interfcace{}, error
	// receives list of items or error.
	GetListByFilter(correlation_id string, filter data.FilterParams, sort data.SortParams) (items []interface{}, err error)
}

Interface for data processing components that can retrieve a list of data items by filter.

type IGetter ¶

type IGetter interface {

	//  Gets a data items by its unique id.
	//  Parameters:
	//  - correlation_id    (optional) transaction id to trace execution through call chain.
	//  - id                an id of item to be retrieved.
	//  Return interface{}, error
	// item or error
	GetOneById(correlation_id string, id interface{}) (item interface{}, err error)
}

Interface for data processing components that can get data items.

<T extends IIdentifiable<K>, K>

type ILoader ¶

type ILoader interface {

	// Loads data items.
	// Parameters:
	// 		- correlation_id string
	//   	transaction id to trace execution through call chain.
	// Retruns []interface{}, error
	// a list of data items or error.
	Load(correlation_id string) (items []interface{}, err error)
}

Interface for data processing components that load data items.

type IPartialUpdater ¶

type IPartialUpdater interface {

	// Updates only few selected fields in a data item.
	// Parameters:
	//		- correlation_id string
	//		transaction id to trace execution through call chain.
	//		- id interface{}
	//      an id of data item to be updated.
	//		- data data.AnyValueMap
	//      a map with fields to be updated.
	// Returns interface{}, error
	// updated item or error.
	UpdatePartially(correlation_id string, id interface{}, data data.AnyValueMap) (item interface{}, err error)
}

Interface for data processing components to update data items partially.

<T, K>

type IQuerablePageReader ¶

type IQuerablePageReader interface {

	//  Gets a page of data items using a query string.
	//  Parameters:
	//  		- correlation_id string
	//			transaction id to trace execution through call chain.
	//  		- query string
	//			 a query string
	//  		- paging data.PagingParams
	//			 paging parameters
	//   		- sort  data.SortParams
	//			 sort parameters
	// Returns interface{}, error
	// receives list of items or error.
	GetPageByQuery(correlation_id string, query string, paging data.PagingParams, sort data.SortParams) (page interface{}, err error)
}

Interface for data processing components that can query a page of data items.

type IQuerableReader ¶

type IQuerableReader interface {

	//  Gets a list of data items using a query string.
	//  Prameters:
	//  		- correlation_id  string
	//			transaction id to trace execution through call chain.
	//  		- query string
	//			a query string
	//  		- sort data.SortParams
	//          sort parameters
	// Returns []interface{}, error
	// list of items or error.
	GetListByQuery(correlation_id string, query string, sort data.SortParams) (items []interface{}, err error)
}

Interface for data processing components that can query a list of data items.

type ISaver ¶

type ISaver interface {

	// Saves given data items.
	// Parameters:
	//		- correlation_id string
	//    	transaction id to trace execution through call chain.
	// 		- items []interface{}
	//      a list of items to save.
	// Retuirns error or nil for success.
	Save(correlation_id string, items []interface{}) error
}

Interface for data processing components that save data items.

type ISetter ¶

type ISetter interface {

	// Sets a data item. If the data item exists it updates it,
	// otherwise it create a new data item.
	// Parameters:
	// 		- correlation_id string
	//	    transaction id to trace execution through call chain.
	// 		- item  interface{}
	//      a item to be set.
	// Retruns interface{}, error
	// updated item or error.
	Set(correlation_id string, item interface{}) (value interface{}, err error)
}

Interface for data processing components that can set (create or update) data items.

type IWriter ¶

type IWriter interface {

	// Creates a data item.
	// Parameters:
	//		- correlation_id string
	//    	transaction id to trace execution through call chain.
	// 		- item interface{}
	//      an item to be created.
	// Returns  interface{}, error
	// created item or error.
	Create(correlation_id string, item interface{}) (value interface{}, err error)

	// Updates a data item.
	// Parameters:
	// 		- correlation_id  string
	//	    transaction id to trace execution through call chain.
	// 		- item interface{}
	//      an item to be updated.
	// Returns: interface{}, error
	// updated item or error.
	Update(correlation_id string, item interface{}) (value interface{}, err error)

	//  Deleted a data item by it's unique id.
	//	Parameters:
	//  		- correlation_id string
	//		    transaction id to trace execution through call chain.
	//  		- id interface{}
	//			 an id of the item to be deleted
	//  Returns: interface{}, error
	//  deleted item or error.
	DeleteById(correlation_id string, id interface{}) (value interface{}, err error)
}

Interface for data processing components that can create, update and delete data items.

type IdentifiableFilePersistence ¶

type IdentifiableFilePersistence struct {
	IdentifiableMemoryPersistence
	Persister *JsonFilePersister
}

Abstract persistence component that stores data in flat files and implements a number of CRUD operations over data items with unique ids. The data items must implement

IIdentifiable interface

In basic scenarios child classes shall only override GetPageByFilter, GetListByFilter or DeleteByFilter operations with specific filter function. All other operations can be used out of the box.

In complex scenarios child classes can implement additional operations by accessing cached items via IdentifiableFilePersistence._items property and calling Save method on updates.

See JsonFilePersister See MemoryPersistence

Configuration parameters ¶

- path: path to the file where data is stored - options:

• max_page_size: Maximum number of items returned in a single page (default: 100)

  References

- *:logger:*:*:1.0 (optional) ILogger components to pass log messages

Examples

type MyFilePersistence  struct {
	IdentifiableFilePersistence
}

    func NewMyFilePersistence(path string)(mfp *MyFilePersistence) {
		mfp = MyFilePersistence{}
		prototype := reflect.TypeOf(MyData{})
		mfp.IdentifiableFilePersistence = *NewJsonPersister(prototype,path)
		return mfp
    }

    func composeFilter(filter cdata.FilterParams)(func (item interface{})bool) {
		if &filter == nil {
			filter = NewFilterParams()
		}
        name := filter.GetAsNullableString("name");
        return func (item interface) bool {
            dummy, ok := item.(MyData)
			if *name != "" && ok && dummy.Name != *name {
				return false
			}
            return true
        }
    }

    func (c *MyFilePersistence ) GetPageByFilter(correlationId string, filter FilterParams, paging PagingParams)(page cdata.MyDataPage, err error){
		tempPage, err := c.GetPageByFilter(correlationId, composeFilter(filter), paging, nil, nil)
		dataLen := int64(len(tempPage.Data))
		data := make([]MyData, dataLen)
		for i, v := range tempPage.Data {
			data[i] = v.(MyData)
		}
		page = *NewMyDataPage(&dataLen, data)
		return page, err
    }

    persistence := NewMyFilePersistence("./data/data.json")

	_, errc := persistence.Create("123", { Id: "1", Name: "ABC" })
	if (errc != nil) {
		panic()
	}
    page, errg := persistence.GetPageByFilter("123", NewFilterParamsFromTuples("Name", "ABC"), nil)
    if errg != nil {
		panic("Error")
	}
    fmt.Println(page.Data)         // Result: { Id: "1", Name: "ABC" )
    persistence.DeleteById("123", "1")

func NewIdentifiableFilePersistence(prototype reflect.Type, persister *JsonFilePersister) *IdentifiableFilePersistence

func (c *IdentifiableFilePersistence) Configure(config config.ConfigParams)

type IdentifiableMemoryPersistence ¶

type IdentifiableMemoryPersistence struct {
	MemoryPersistence
	MaxPageSize int
}

Abstract persistence component that stores data in memory and implements a number of CRUD operations over data items with unique ids. The data items must have Id field.

In basic scenarios child structs shall only override GetPageByFilter, GetListByFilter or DeleteByFilter operations with specific filter function. All other operations can be used out of the box.

In complex scenarios child structes can implement additional operations by accessing cached items via c.Items property and calling Save method on updates.

See MemoryPersistence ¶

Configuration parameters ¶

- options:

• max_page_size: Maximum number of items returned in a single page (default: 100)

  References

- *:logger:*:*:1.0 (optional) ILogger components to pass log messages

Examples

type MyMemoryPersistence struct{
	IdentifiableMemoryPersistence
}

    func composeFilter(filter: FilterParams) (func (item interface{}) bool ) {
        if &filter == nil {
			filter = NewFilterParams()
		}
        name := filter.getAsNullableString("Name");
        return func(item interface{}) bool {
			dummy, ok := item.(MyData)
            if (*name != "" && ok && item.Name != *name)
                return false;
            return true;
        };
    }

    func (mmp * MyMemoryPersistence) GetPageByFilter(correlationId string, filter FilterParams, paging PagingParams) (page DataPage, err error) {
        tempPage, err := c.GetPageByFilter(correlationId, composeFilter(filter), paging, nil, nil)
		dataLen := int64(len(tempPage.Data))
		data := make([]MyData, dataLen)
		for i, v := range tempPage.Data {
			data[i] = v.(MyData)
		}
		page = *NewMyDataPage(&dataLen, data)
		return page, err}

    persistence := NewMyMemoryPersistence();

	item, err := persistence.Create("123", { Id: "1", Name: "ABC" })
	...
	page, err := persistence.GetPageByFilter("123", NewFilterParamsFromTuples("Name", "ABC"), nil)
	if err != nil {
		panic("Error can't get data")
	}
    fmt.Prnitln(page.data)         // Result: { Id: "1", Name: "ABC" }
	item, err := persistence.DeleteById("123", "1")
	...

extends MemoryPersistence implements IConfigurable, IWriter, IGetter, ISetter

func NewIdentifiableMemoryPersistence(prototype reflect.Type) (c *IdentifiableMemoryPersistence)

func (c *IdentifiableMemoryPersistence) Configure(config config.ConfigParams)

func (c *IdentifiableMemoryPersistence) Create(correlationId string, item interface{}) (result interface{}, err error)

func (c *IdentifiableMemoryPersistence) DeleteByFilter(correlationId string, filterFunc func(interface{}) bool) (err error)

func (c *IdentifiableMemoryPersistence) DeleteById(correlationId string, id interface{}) (result interface{}, err error)

func (c *IdentifiableMemoryPersistence) DeleteByIds(correlationId string, ids []interface{}) (err error)

func (c *IdentifiableMemoryPersistence) GetListByFilter(correlationId string, filterFunc func(interface{}) bool,
	sortFunc func(a, b interface{}) bool, selectFunc func(in interface{}) (out interface{})) (results []interface{}, err error)

func (c *IdentifiableMemoryPersistence) GetListByIds(correlationId string, ids []interface{}) (result []interface{}, err error)

func (c *IdentifiableMemoryPersistence) GetOneById(correlationId string, id interface{}) (result interface{}, err error)

func (c *IdentifiableMemoryPersistence) GetOneRandom(correlationId string, filterFunc func(interface{}) bool) (result interface{}, err error)

func (c *IdentifiableMemoryPersistence) GetPageByFilter(correlationId string, filterFunc func(interface{}) bool,
	paging cdata.PagingParams, sortFunc func(a, b interface{}) bool, selectFunc func(in interface{}) (out interface{})) (page cdata.DataPage, err error)

func (c *IdentifiableMemoryPersistence) Set(correlationId string, item interface{}) (result interface{}, err error)

func (c *IdentifiableMemoryPersistence) Update(correlationId string, item interface{}) (result interface{}, err error)

func (c *IdentifiableMemoryPersistence) UpdatePartially(correlationId string, id interface{}, data cdata.AnyValueMap) (result interface{}, err error)

type JsonFilePersister ¶

type JsonFilePersister struct {
	Prototype reflect.Type
	// contains filtered or unexported fields
}

Persistence component that loads and saves data from/to flat file.

It is used by FilePersistence, but can be useful on its own.

Configuration parameters

- path: path to the file where data is stored

 Example

    persister := NewJsonFilePersister(reflect.TypeOf(MyData{}), "./data/data.json");

	err_sav := persister.Save("123", ["A", "B", "C"])
	if err_sav == nil {
		items, err_lod := persister.Load("123")
		if err_lod == nil {
			fmt.Println(items);// Result: ["A", "B", "C"]
		}

implements ILoader, ISaver, IConfigurable

func NewJsonFilePersister(prototype reflect.Type, path string) *JsonFilePersister

func (c *JsonFilePersister) Configure(config config.ConfigParams)

func (c *JsonFilePersister) Load(correlation_id string) (data []interface{}, err error)

func (c *JsonFilePersister) Path() string

func (c *JsonFilePersister) Save(correlationId string, items []interface{}) error

func (c *JsonFilePersister) SetPath(value string)

type MemoryPersistence ¶

type MemoryPersistence struct {
	Logger *log.CompositeLogger
	Items  []interface{}
	Loader ILoader
	Saver  ISaver

	Prototype reflect.Type
	Lock      sync.RWMutex
	// contains filtered or unexported fields
}

Abstract persistence component that stores data in memory.

This is the most basic persistence component that is only able to store data items of any type. Specific CRUD operations over the data items must be implemented in child struct by accessing Items property and calling Save method.

The component supports loading and saving items from another data source. That allows to use it as a base struct for file and other types of persistence components that cache all data in memory.

References ¶

- *:logger:*:*:1.0 ILogger components to pass log messages

Example

type MyMemoryPersistence struct {
    MemoryPersistence

}
 func (c * MyMemoryPersistence) GetByName(correlationId string, name string)(item interface{}, err error) {
    for _, v := range c.Items {
        if v.name == name {
            item = v
            break
        }
    }
    return item, nil
});

func (c * MyMemoryPersistence) Set(correlatonId: string, item: MyData, callback: (err) => void): void {
    c.Items = append(c.Items, item);
    c.Save(correlationId);
}

persistence := NewMyMemoryPersistence();
err := persistence.Set("123", MyData{ name: "ABC" })
item, err := persistence.GetByName("123", "ABC")
fmt.Println(item)   // Result: { name: "ABC" }

implements IReferenceable, IOpenable, ICleanable

func NewMemoryPersistence(prototype reflect.Type) *MemoryPersistence

func (c *MemoryPersistence) Clear(correlationId string) error

func (c *MemoryPersistence) Close(correlationId string) error

func (c *MemoryPersistence) IsOpen() bool

func (c *MemoryPersistence) Open(correlationId string) error

func (c *MemoryPersistence) Save(correlationId string) error

func (c *MemoryPersistence) SetReferences(references refer.IReferences)

 Sets references to dependent components.
 Parameters:
		- references refer.IReferences
		references to locate the component dependencies.