Class GrapholEntity

Export

Interface

Entity

Hierarchy

AnnotatedElement
- GrapholEntity

Implements

Entity

Constructors

constructor

new GrapholEntity(iri: Iri): GrapholEntity
Parameters
- iri: Iri
Returns GrapholEntity
Overrides AnnotatedElement.constructor
- Defined in src/model/graphol-elems/entity.ts:43

Properties

`Private` `Optional` _color

_color?: string

`Private` _datatype

_datatype: string

`Private` _functionProperties

_functionProperties: FunctionPropertiesEnum[] = []

`Private` _iri

_iri: Iri

`Private` _isDataPropertyFunctional

_isDataPropertyFunctional: boolean = false

`Protected` `Optional` _manualTypes

_manualTypes?: Set<TypesEnum>

`Private` _occurrences

_occurrences: Map<RendererStatesEnum, GrapholElement[]> = ...

Accessors

annotations

set annotations(annotations: Annotation[]): void
Memberof
Entity
Parameters
- annotations: Annotation[]
Returns void
Implementation of Entity.annotations

Inherited from AnnotatedElement.annotations
- Defined in src/model/annotated-element.ts:12

color

get color(): undefined | string
Returns undefined | string
- Defined in src/model/graphol-elems/entity.ts:164
set color(color: undefined | string): void
Parameters
- color: undefined | string
Returns void
- Defined in src/model/graphol-elems/entity.ts:165

datatype

get datatype(): string
Memberof
Entity

Returns string
Implementation of Entity.datatype
- Defined in src/model/graphol-elems/entity.ts:161
set datatype(datatype: string): void
Memberof
Entity
Parameters
- datatype: string
Returns void
Implementation of Entity.datatype
- Defined in src/model/graphol-elems/entity.ts:162

fullIri

get fullIri(): string
Memberof
Entity

Returns string
Implementation of Entity.fullIri
- Defined in src/model/graphol-elems/entity.ts:141

functionProperties

get functionProperties(): FunctionPropertiesEnum[]
Memberof
Entity

Returns FunctionPropertiesEnum[]
Implementation of Entity.functionProperties
- Defined in src/model/graphol-elems/entity.ts:145
set functionProperties(properties: FunctionPropertiesEnum[]): void
Memberof
Entity
Parameters
- properties: FunctionPropertiesEnum[]
Returns void
Implementation of Entity.functionProperties
- Defined in src/model/graphol-elems/entity.ts:149

iri

get iri(): Iri
Returns Iri
- Defined in src/model/graphol-elems/entity.ts:137
set iri(val: Iri): void
Parameters
- val: Iri
Returns void
- Defined in src/model/graphol-elems/entity.ts:133

isDataPropertyFunctional

get isDataPropertyFunctional(): boolean
Memberof
Entity

Returns boolean
Implementation of Entity.isDataPropertyFunctional
- Defined in src/model/graphol-elems/entity.ts:153
set isDataPropertyFunctional(value: boolean): void
Memberof
Entity
Parameters
- value: boolean
Returns void
Implementation of Entity.isDataPropertyFunctional
- Defined in src/model/graphol-elems/entity.ts:157

manualTypes

set manualTypes(newTypes: Set<TypesEnum>): void
Parameters
- newTypes: Set<TypesEnum>
Returns void
- Defined in src/model/graphol-elems/entity.ts:107

occurrences

get occurrences(): Map<RendererStatesEnum, GrapholElement[]>
Returns Map<RendererStatesEnum, GrapholElement[]>
- Defined in src/model/graphol-elems/entity.ts:129

types

get types(): TypesEnum[]
Returns TypesEnum[]
- Defined in src/model/graphol-elems/entity.ts:92

Methods

addAnnotation

addAnnotation(newAnnotation: Annotation): void
Parameters
- newAnnotation: Annotation
Returns void
Inherited from AnnotatedElement.addAnnotation
- Defined in src/model/annotated-element.ts:16

addOccurrence

addOccurrence(newGrapholElement: GrapholElement, representationKind?: RendererStatesEnum): void
Parameters
- newGrapholElement: GrapholElement
- representationKind: RendererStatesEnum = RendererStatesEnum.GRAPHOL
Returns void
- Defined in src/model/graphol-elems/entity.ts:48

getAnnotations

getAnnotations(language?: string, annotationProperty?: Iri): Annotation[]
Parameters
- Optional language: string
- Optional annotationProperty: Iri
Returns Annotation[]
Inherited from AnnotatedElement.getAnnotations
- Defined in src/model/annotated-element.ts:29

getComments

getComments(language?: string): Annotation[]
Parameters
- Optional language: string
Returns Annotation[]
Inherited from AnnotatedElement.getComments
- Defined in src/model/annotated-element.ts:48

getDisplayedName

getDisplayedName(nameType: RDFGraphConfigEntityNameTypeEnum, currentLanguage?: string): string
Parameters
- nameType: RDFGraphConfigEntityNameTypeEnum
- Optional currentLanguage: string
Returns string
- Defined in src/model/graphol-elems/entity.ts:198

getEntityOriginalNodeId

getEntityOriginalNodeId(): undefined | string
Returns undefined | string
- Defined in src/model/graphol-elems/entity.ts:225

getIdInDiagram

getIdInDiagram(diagramId: number, type: TypesEnum, rendererState: RendererStatesEnum): undefined | string
Parameters
- diagramId: number
- type: TypesEnum
- rendererState: RendererStatesEnum
Returns undefined | string
- Defined in src/model/graphol-elems/entity.ts:232

getLabels

getLabels(language?: string): Annotation[]
Parameters
- Optional language: string
Returns Annotation[]
Inherited from AnnotatedElement.getLabels
- Defined in src/model/annotated-element.ts:44

getOccurrenceByType

getOccurrenceByType(type: TypesEnum, rendererState: RendererStatesEnum): undefined | GrapholElement
Parameters
- type: TypesEnum
- rendererState: RendererStatesEnum
Returns undefined | GrapholElement
- Defined in src/model/graphol-elems/entity.ts:167

getOccurrencesByDiagramId

getOccurrencesByDiagramId(diagramId: number, representationKind?: RendererStatesEnum): Map<RendererStatesEnum, GrapholElement[]>
Get all occurrences of the entity in a given diagram

Returns
A map with the occurrences in the original Graphol representation and other replicated occurrences in other diagram representations
Parameters
- diagramId: number
  
  the diagram in which the entity must occurr
- Optional representationKind: RendererStatesEnum
  
  the diagram representation identifier (RendererStatesEnum) if not set, all representations will be considered
Returns Map<RendererStatesEnum, GrapholElement[]>
- Defined in src/model/graphol-elems/entity.ts:77

getOccurrencesByType

getOccurrencesByType(type: TypesEnum, rendererState: RendererStatesEnum): undefined | GrapholElement[]
Parameters
- type: TypesEnum
- rendererState: RendererStatesEnum
Returns undefined | GrapholElement[]
- Defined in src/model/graphol-elems/entity.ts:171

hasFunctionProperty

hasFunctionProperty(property: FunctionPropertiesEnum): boolean
Parameters
- property: FunctionPropertiesEnum
Returns boolean
- Defined in src/model/graphol-elems/entity.ts:175

hasOccurrenceInDiagram

hasOccurrenceInDiagram(diagramId: number, representationKind: RendererStatesEnum): boolean
Parameters
- diagramId: number
- representationKind: RendererStatesEnum
Returns boolean
- Defined in src/model/graphol-elems/entity.ts:183

is

is(type: TypesEnum): boolean
Check if entity is of a certain type
Parameters
- type: TypesEnum
Returns boolean
- Defined in src/model/graphol-elems/entity.ts:115

json

json(): Entity
Returns Entity
- Defined in src/model/graphol-elems/entity.ts:244

removeAnnotation

removeAnnotation(annotation: Annotation): void
Parameters
- annotation: Annotation
Returns void
Inherited from AnnotatedElement.removeAnnotation
- Defined in src/model/annotated-element.ts:25

removeOccurrence

removeOccurrence(grapholElement: GrapholElement, representationKind: RendererStatesEnum): void
Parameters
- grapholElement: GrapholElement
- representationKind: RendererStatesEnum
Returns void
- Defined in src/model/graphol-elems/entity.ts:60

`Static` newFromSwagger

newFromSwagger(iri: Iri, e: Entity): GrapholEntity
Parameters
- iri: Iri
- e: Entity
Returns GrapholEntity
- Defined in src/model/graphol-elems/entity.ts:19

Class GrapholEntity

Export

Interface

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

iri: Iri

Returns GrapholEntity

Properties

Private Optional _color

Private _datatype

Private _functionProperties

Private _iri

Private _isDataPropertyFunctional

Protected Optional _manualTypes

Private _occurrences

Accessors

annotations

Memberof

Parameters

annotations: Annotation[]

Returns void

color

Returns undefined | string

Parameters

color: undefined | string

Returns void

datatype

Memberof

Returns string

Memberof

Parameters

datatype: string

Returns void

fullIri

Memberof

Returns string

functionProperties

Memberof

Returns FunctionPropertiesEnum[]

Memberof

Parameters

properties: FunctionPropertiesEnum[]

Returns void

iri

Returns Iri

Parameters

val: Iri

Returns void

isDataPropertyFunctional

Memberof

Returns boolean

Memberof

Parameters

value: boolean

Returns void

manualTypes

Parameters

newTypes: Set<TypesEnum>

Returns void

occurrences

Returns Map<RendererStatesEnum, GrapholElement[]>

types

Returns TypesEnum[]

Methods

addAnnotation

Parameters

newAnnotation: Annotation

Returns void

addOccurrence

Parameters

newGrapholElement: GrapholElement

representationKind: RendererStatesEnum = RendererStatesEnum.GRAPHOL

`Private` `Optional` _color

`Private` _datatype

`Private` _functionProperties

`Private` _iri

`Private` _isDataPropertyFunctional

`Protected` `Optional` _manualTypes

`Private` _occurrences

`Optional` language: string

`Optional` annotationProperty: Iri

`Optional` language: string

`Optional` currentLanguage: string

`Optional` language: string

`Optional` representationKind: RendererStatesEnum

`Static` newFromSwagger