Class BAttribute

Attribute is an abstract concept which has two real uses - label (key - value pair) and relation (representing named relationship between source and target note)

Hierarchy (View Summary)

AbstractBeccaEntity<BAttribute>
- BAttribute

Constructors

constructor

new BAttribute(row?: AttributeRow): BAttribute
Parameters
- Optionalrow: AttributeRow
Returns BAttribute
Overrides AbstractBeccaEntity.constructor
- Defined in src/becca/entities/battribute.ts:37

Properties

attributeId

attributeId: string

`Optional`blobId

blobId?: string

`Optional`dateCreated

dateCreated?: string

`Optional`dateModified

dateModified?: string

isInheritable

isInheritable: boolean

`Optional`isProtected

isProtected?: boolean

`Optional`isSynced

isSynced?: boolean

name

name: string

noteId

noteId: string

position

position: number

type

type: AttributeType

utcDateCreated

utcDateCreated: string

`Optional`utcDateModified

utcDateModified?: string

value

value: string

Accessors

`Protected`becca

get becca(): default
Returns default
Inherited from AbstractBeccaEntity.becca
- Defined in src/becca/entities/abstract_becca_entity.ts:47

isAffectingSubtree

get isAffectingSubtree(): boolean
Returns boolean
- Defined in src/becca/entities/battribute.ts:102

isDeleted

get isDeleted(): boolean
Returns boolean
Overrides AbstractBeccaEntity.isDeleted
- Defined in src/becca/entities/battribute.ts:165

note

get note(): BNote
Returns BNote
- Defined in src/becca/entities/battribute.ts:115

targetNote

get targetNote(): undefined | BNote
Returns undefined | BNote
- Defined in src/becca/entities/battribute.ts:119

targetNoteId

get targetNoteId(): undefined | string
Returns undefined | string
- Defined in src/becca/entities/battribute.ts:106

`Static`entityName

get entityName(): string
Returns string
- Defined in src/becca/entities/battribute.ts:19

`Static`hashedProperties

get hashedProperties(): string[]
Returns string[]
- Defined in src/becca/entities/battribute.ts:25

`Static`primaryKeyName

get primaryKeyName(): string
Returns string
- Defined in src/becca/entities/battribute.ts:22

Methods

`Protected`_getContent

_getContent(): string | Buffer<ArrayBufferLike>
Returns string | Buffer<ArrayBufferLike>
Inherited from AbstractBeccaEntity._getContent
- Defined in src/becca/entities/abstract_becca_entity.ts:261

`Protected`_setContent

_setContent(content: string | Buffer<ArrayBufferLike>, opts?: ContentOpts): void
Parameters
- content: string | Buffer<ArrayBufferLike>
- opts: ContentOpts = {}
Returns void
Inherited from AbstractBeccaEntity._setContent
- Defined in src/becca/entities/abstract_becca_entity.ts:140

beforeSaving

beforeSaving(opts?: SavingOpts): void
Parameters
- opts: SavingOpts = {}
Returns void
Overrides AbstractBeccaEntity.beforeSaving
- Defined in src/becca/entities/battribute.ts:169

createClone

createClone(
    type: AttributeType,
    name: string,
    value: string,
    isInheritable?: boolean,
): BAttribute
Parameters
- type: AttributeType
- name: string
- value: string
- OptionalisInheritable: boolean
Returns BAttribute
- Defined in src/becca/entities/battribute.ts:214

generateHash

generateHash(isDeleted?: boolean): string
Parameters
- OptionalisDeleted: boolean
Returns string
Inherited from AbstractBeccaEntity.generateHash
- Defined in src/becca/entities/abstract_becca_entity.ts:63

getDefinedName

getDefinedName(): string
Returns string
- Defined in src/becca/entities/battribute.ts:155

getDefinition

getDefinition(): DefinitionObject
Returns DefinitionObject
- Defined in src/becca/entities/battribute.ts:151

getNote

getNote(): BNote
Returns BNote
- Defined in src/becca/entities/battribute.ts:125

getPojo

getPojo(): {
    attributeId: string;
    isDeleted: boolean;
    isInheritable: boolean;
    name: string;
    noteId: string;
    position: number;
    type: AttributeType;
    utcDateModified: undefined
    | string;
    value: string;
}
Returns {
    attributeId: string;
    isDeleted: boolean;
    isInheritable: boolean;
    name: string;
    noteId: string;
    position: number;
    type: AttributeType;
    utcDateModified: undefined | string;
    value: string;
}
Overrides AbstractBeccaEntity.getPojo
- Defined in src/becca/entities/battribute.ts:200

`Protected`getPojoToSave

getPojoToSave(): {}
Returns {}
Inherited from AbstractBeccaEntity.getPojoToSave
- Defined in src/becca/entities/abstract_becca_entity.ts:78

getTargetNote

getTargetNote(): null | BNote
Returns null | BNote
- Defined in src/becca/entities/battribute.ts:135

isAutoLink

isAutoLink(): boolean
Returns boolean
- Defined in src/becca/entities/battribute.ts:111

isDefinition

isDefinition(): boolean
Returns boolean
- Defined in src/becca/entities/battribute.ts:147

markAsDeleted

markAsDeleted(deleteId?: null | string): void
Mark the entity as (soft) deleted. It will be completely erased later.

This is a low-level method, for notes and branches use note.deleteNote() and 'branch.deleteBranch()` instead.
Parameters
- deleteId: null | string = null
Returns void
Inherited from AbstractBeccaEntity.markAsDeleted
- Defined in src/becca/entities/abstract_becca_entity.ts:277

markAsDeletedSimple

markAsDeletedSimple(): void
Returns void
Inherited from AbstractBeccaEntity.markAsDeletedSimple
- Defined in src/becca/entities/abstract_becca_entity.ts:303

`Protected`putEntityChange

putEntityChange(isDeleted: boolean): void
Parameters
- isDeleted: boolean
Returns void
Inherited from AbstractBeccaEntity.putEntityChange
- Defined in src/becca/entities/abstract_becca_entity.ts:51

save

save(opts?: {}): this
Saves entity - executes SQL, but doesn't commit the transaction on its own
Parameters
- Optionalopts: {}
Returns this
Inherited from AbstractBeccaEntity.save
- Defined in src/becca/entities/abstract_becca_entity.ts:103

update

update(__namedParameters: any): BAttribute
Parameters
- __namedParameters: any
Returns BAttribute
- Defined in src/becca/entities/battribute.ts:52

updateFromRow

updateFromRow(row: AttributeRow): void
Parameters
- row: AttributeRow
Returns void
Overrides AbstractBeccaEntity.updateFromRow
- Defined in src/becca/entities/battribute.ts:48

validate

validate(): void
Returns void
- Defined in src/becca/entities/battribute.ts:88

Class BAttribute

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BAttribute

Properties

attributeId

OptionalblobId

OptionaldateCreated

OptionaldateModified

isInheritable

OptionalisProtected

OptionalisSynced

name

noteId

position

type

utcDateCreated

OptionalutcDateModified

value

Accessors

Protectedbecca

Returns default

isAffectingSubtree

Returns boolean

isDeleted

Returns boolean

note

Returns BNote

targetNote

Returns undefined | BNote

targetNoteId

Returns undefined | string

StaticentityName

Returns string

StatichashedProperties

Returns string[]

StaticprimaryKeyName

Returns string

Methods

Protected_getContent

Returns string | Buffer<ArrayBufferLike>

Protected_setContent

Parameters

Returns void

beforeSaving

Parameters

Returns void

createClone

Parameters

Returns BAttribute

generateHash

Parameters

Returns string

getDefinedName

Returns string

getDefinition

Returns DefinitionObject

getNote

Returns BNote

getPojo

Returns { attributeId: string; isDeleted: boolean; isInheritable: boolean; name: string; noteId: string; position: number; type: AttributeType; utcDateModified: undefined | string; value: string;}

ProtectedgetPojoToSave

Returns {}

getTargetNote

Returns null | BNote

getUtcDateChanged

Returns string

hasStringContent

Returns boolean

init

Returns void

isAutoLink

Returns boolean

`Optional`blobId

`Optional`dateCreated

`Optional`dateModified

`Optional`isProtected

`Optional`isSynced

`Optional`utcDateModified

`Protected`becca

`Static`entityName

`Static`hashedProperties

`Static`primaryKeyName

`Protected`_getContent

`Protected`_setContent

Returns {
attributeId: string;
isDeleted: boolean;
isInheritable: boolean;
name: string;
noteId: string;
position: number;
type: AttributeType;
utcDateModified: undefined | string;
value: string;
}

`Protected`getPojoToSave

`Protected`putEntityChange