API Docs for:
Show:

GeneralFactory Class

Defined in: /home/ubuntu/base-domain/src/lib/general-factory.coffee:7
Module: base-domain

general factory class

create instance of model

Methods

create

(
  • modelName
  • root
)
FactoryInterface static

Defined in /home/ubuntu/base-domain/src/lib/general-factory.coffee:18

create a factory. If specific factory is defined, return the instance. Otherwise, return instance of GeneralFactory. This method is not suitable for creating collections, thus only called by Repository, which handles Entity (= non-collection).

Parameters:

Returns:

FactoryInterface:

createCollection

(
  • collModelName
  • val
  • [options]
)
BaseDict private

Defined in /home/ubuntu/base-domain/src/lib/general-factory.coffee:230

create collection

Parameters:

  • collModelName String

    model name of collection

  • val Any
  • [options] Object optional

Returns:

BaseDict:

dict

createDict

(
  • dictModelName
  • val
  • [options]
)
BaseDict public

Defined in /home/ubuntu/base-domain/src/lib/general-factory.coffee:214

create model dict

Parameters:

  • dictModelName String

    model name of dict

  • val Any
  • [options] Object optional
    • [include] Object optional

      options to pass to Includer

      • [async=false] Object optional
        include sub-entities asynchronously if true.
      • [props] Array(String) optional
        include sub-entities of given props

Returns:

BaseDict:

dict

createEmpty

() BaseModel public

Defined in /home/ubuntu/base-domain/src/lib/general-factory.coffee:92

create empty model instance

Returns:

BaseModel:

createFromObject

(
  • obj
  • [options={}]
)
BaseModel public

Defined in /home/ubuntu/base-domain/src/lib/general-factory.coffee:101

create instance of model class by plain object

for each prop, values are set by Model#set(prop, value)

Parameters:

  • obj Object
  • [options={}] Object optional
    • [include] Object optional

      options to pass to Includer

      • [async=false] Object optional
        include sub-entities asynchronously if true.
      • [props] Array(String) optional
        include sub-entities of given props

Returns:

BaseModel:

model

createList

(
  • listModelName
  • val
  • [options]
)
BaseList public

Defined in /home/ubuntu/base-domain/src/lib/general-factory.coffee:198

create model list

Parameters:

  • listModelName String

    model name of list

  • val Any
  • [options] Object optional
    • [include] Object optional

      options to pass to Includer

      • [async=false] Object optional
        include sub-entities asynchronously if true.
      • [props] Array(String) optional
        include sub-entities of given props

Returns:

BaseList:

list

createModel

(
  • modelName
  • obj
  • [options]
  • root
)
BaseModel

Defined in /home/ubuntu/base-domain/src/lib/general-factory.coffee:39

create an instance of the given modelName using obj if obj is null, return null if obj is undefined, empty object is created.

Parameters:

  • modelName String
  • obj Object
  • [options] Object optional
    • [include] Object optional

      options to pass to Includer

      • [async=false] Object optional
        include sub-entities asynchronously if true.
      • [props] Array(String) optional
        include sub-entities of given props
  • root RootInterface

Returns:

BaseModel:

getModelClass

() Function

Defined in /home/ubuntu/base-domain/src/lib/general-factory.coffee:82

get model class this factory handles

Returns:

Function:

include

(
  • model
  • [includeOptions]
)
private

Defined in /home/ubuntu/base-domain/src/lib/general-factory.coffee:179

include submodels

Parameters:

  • model BaseModel
  • [includeOptions] Object optional
    • [async=false] Object optional

      include submodels asynchronously

    • [props] Array(String) optional

      include submodels of given props