Class Ontology

Ontology

Class used as the Model of the whole app.

Hierarchy

AnnotatedElement
- Ontology

Implements

RDFGraphMetadata

Index

Constructors

constructor

new Ontology(name: string, version: string, iri?: string, namespaces?: Namespace[], annProperties?: AnnotationProperty[], diagrams?: Diagram[]): Ontology
Parameters
- name: string
- version: string
- Optional iri: string
- namespaces: Namespace[] = []
- annProperties: AnnotationProperty[] = []
- diagrams: Diagram[] = []
Returns Ontology
Overrides AnnotatedElement.constructor
- Defined in src/model/ontology.ts:34

Properties

`Private` _entities

_entities: Map<string, GrapholEntity> = ...

`Private` _hierarchies

_hierarchies: Map<string, Hierarchy> = ...

`Private` _inclusions

_inclusions: {
subclass: GrapholEntity;
superclass: GrapholEntity;
}[] = []

`Private` _subHierarchiesMap

_subHierarchiesMap: Map<string, Set<Hierarchy>> = ...

`Private` _superHierarchiesMap

_superHierarchiesMap: Map<String, Set<Hierarchy>> = ...

annProperties

annProperties: AnnotationProperty[] = []

`Optional` defaultLanguage

defaultLanguage?: string

Memberof

RDFGraphMetadata

diagrams

diagrams: (Diagram | AnnotationsDiagram)[] = []

`Optional` iri

iri?: string

Memberof

RDFGraphMetadata

languages

languages: string[] = []

Memberof

RDFGraphMetadata

name

name: string

Memberof

RDFGraphMetadata

namespaces

namespaces: Namespace[] = []

Memberof

RDFGraphMetadata

ontologyEntity

ontologyEntity: GrapholEntity

usedColorScales

usedColorScales: string[] = []

version

version: string

Memberof

RDFGraphMetadata

Accessors

annotations

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

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

annotationsDiagram

get annotationsDiagram(): undefined | AnnotationsDiagram
Returns undefined | AnnotationsDiagram
- Defined in src/model/ontology.ts:438

entities

get entities(): Map<string, GrapholEntity>
Returns Map<string, GrapholEntity>
- Defined in src/model/ontology.ts:433
set entities(newEntities: Map<string, GrapholEntity>): void
Parameters
- newEntities: Map<string, GrapholEntity>
Returns void
- Defined in src/model/ontology.ts:434

isEntitiesEmpty

get isEntitiesEmpty(): boolean
Returns boolean
- Defined in src/model/ontology.ts:431

Methods

addAnnotation

addAnnotation(newAnnotation: Annotation): void
Parameters
- newAnnotation: Annotation
Returns void
Overrides AnnotatedElement.addAnnotation
- Defined in src/model/ontology.ts:401

addAnnotationProperty

addAnnotationProperty(annProperty: AnnotationProperty): void
Parameters
- annProperty: AnnotationProperty
Returns void
- Defined in src/model/ontology.ts:245

addDiagram

addDiagram(diagram: Diagram): void
Parameters
- diagram: Diagram
Returns void
- Defined in src/model/ontology.ts:264

addEntity

addEntity(entity: GrapholEntity): void
Parameters
- entity: GrapholEntity
Returns void
- Defined in src/model/ontology.ts:279

addHierarchy

addHierarchy(hierarchy: Hierarchy): void
Parameters
- hierarchy: Hierarchy
Returns void
- Defined in src/model/ontology.ts:56

addNamespace

addNamespace(namespace: Namespace): void
Parameters
- namespace: Namespace
Returns void
- Defined in src/model/ontology.ts:218

addSubclassOf

addSubclassOf(subclassIri: string | Iri, superclassIri: string | Iri): void
Parameters
- subclassIri: string | Iri
- superclassIri: string | Iri
Returns void
- Defined in src/model/ontology.ts:167
addSubclassOf(subclass: GrapholEntity, superclass: GrapholEntity): void
Parameters
- subclass: GrapholEntity
- superclass: GrapholEntity
Returns void
- Defined in src/model/ontology.ts:168

computeDatatypesOnDataProperties

computeDatatypesOnDataProperties(): void
Returns void
- Defined in src/model/ontology.ts:364

getAnnotationProperties

getAnnotationProperties(): AnnotationProperty[]
Returns AnnotationProperty[]
- Defined in src/model/ontology.ts:258

getAnnotationProperty

getAnnotationProperty(iriValue: string): undefined | AnnotationProperty
Get the Namspace object given its IRI string

Returns
Parameters
- iriValue: string
  
  the IRI assigned to the namespace
Returns undefined | AnnotationProperty
- Defined in src/model/ontology.ts:254

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

getDiagram

getDiagram(diagramId: number): undefined | Diagram
Get the diagram with the given id
Parameters
- diagramId: number
Returns undefined | Diagram
- Defined in src/model/ontology.ts:271

getDiagramByName

getDiagramByName(name: string): undefined | Diagram
Parameters
- name: string
Returns undefined | Diagram
- Defined in src/model/ontology.ts:275

getEntitiesByType

getEntitiesByType(entityType: TypesEnum): GrapholEntity[]
Parameters
- entityType: TypesEnum
Returns GrapholEntity[]
- Defined in src/model/ontology.ts:287

getEntity

getEntity(iri: string | Iri): undefined | GrapholEntity
Parameters
- iri: string | Iri
Returns undefined | GrapholEntity
- Defined in src/model/ontology.ts:283

getEntityFromOccurrence

getEntityFromOccurrence(entityOccurrence: GrapholElement): undefined | GrapholEntity
Parameters
- entityOccurrence: GrapholElement
Returns undefined | GrapholEntity
- Defined in src/model/ontology.ts:291

getEntityOccurrences

getEntityOccurrences(iri: string, diagramId?: number, renderState?: RendererStatesEnum): undefined | Map<RendererStatesEnum, GrapholElement[]>
Retrieve all occurrences of an entity by its IRI.

Returns
An array of EntityOccurrence objects
Parameters
- iri: string
  
  The IRI in full or prefixed form. i.e. : grapholscape:world or https://examples/grapholscape/world
- Optional diagramId: number
- Optional renderState: RendererStatesEnum
Returns undefined | Map<RendererStatesEnum, GrapholElement[]>
- Defined in src/model/ontology.ts:339

getGrapholEdge

getGrapholEdge(edgeId: string, diagramId?: number, renderState?: RendererStatesEnum): undefined | GrapholNode
Parameters
- edgeId: string
- Optional diagramId: number
- renderState: RendererStatesEnum = RendererStatesEnum.GRAPHOL
Returns undefined | GrapholNode
- Defined in src/model/ontology.ts:324

getGrapholElement

getGrapholElement(elementId: string, diagramId?: number, renderState?: RendererStatesEnum): undefined | GrapholElement
Parameters
- elementId: string
- Optional diagramId: number
- renderState: RendererStatesEnum = RendererStatesEnum.GRAPHOL
Returns undefined | GrapholElement
- Defined in src/model/ontology.ts:305

getGrapholNode

getGrapholNode(nodeId: string, diagramId?: number, renderState?: RendererStatesEnum): undefined | GrapholNode
Parameters
- nodeId: string
- Optional diagramId: number
- renderState: RendererStatesEnum = RendererStatesEnum.GRAPHOL
Returns undefined | GrapholNode
- Defined in src/model/ontology.ts:315

getHierarchiesOf

getHierarchiesOf(classIri: string | Iri): Hierarchy[]
Parameters
- classIri: string | Iri
Returns Hierarchy[]
- Defined in src/model/ontology.ts:104

getHierarchy

getHierarchy(hierarchyId: string): undefined | Hierarchy
Parameters
- hierarchyId: string
Returns undefined | Hierarchy
- Defined in src/model/ontology.ts:100

getLabels

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

getNamespace

getNamespace(iriValue: string): undefined | Namespace
Get the Namspace object given its IRI string

Returns
Parameters
- iriValue: string
  
  the IRI assigned to the namespace
Returns undefined | Namespace
- Defined in src/model/ontology.ts:227

getNamespaceFromPrefix

getNamespaceFromPrefix(prefix: string): undefined | Namespace
Get the Namespace given one of its prefixes

Returns
Parameters
- prefix: string
Returns undefined | Namespace
- Defined in src/model/ontology.ts:236

getNamespaces

getNamespaces(): Namespace[]
Returns Namespace[]
- Defined in src/model/ontology.ts:240

getSubHierarchiesOf

getSubHierarchiesOf(superClassIri: string | Iri): Hierarchy[]
Returns
The arrary of hiearchies for which a class appear as superclass
Parameters
- superClassIri: string | Iri
  
  the superclass iri
Returns Hierarchy[]
- Defined in src/model/ontology.ts:116

getSubclassesOf

getSubclassesOf(superClassIri: string | Iri): Set<GrapholEntity>
Parameters
- superClassIri: string | Iri
Returns Set<GrapholEntity>
- Defined in src/model/ontology.ts:135

getSuperHierarchiesOf

getSuperHierarchiesOf(subClassIri: string | Iri): Hierarchy[]
Returns
The arrary of hiearchies for which a class appear as subclass
Parameters
- subClassIri: string | Iri
Returns Hierarchy[]
- Defined in src/model/ontology.ts:128

getSuperclassesOf

getSuperclassesOf(superClassIri: string | Iri): Set<GrapholEntity>
Parameters
- superClassIri: string | Iri
Returns Set<GrapholEntity>
- Defined in src/model/ontology.ts:151

prefixedToFullIri

prefixedToFullIri(prefixedIri: string): undefined | string
Retrieve the full IRI given a prefixed IRI

Returns
full IRI
Parameters
- prefixedIri: string
  
  a prefixed IRI
Returns undefined | string
- Defined in src/model/ontology.ts:351

removeAnnotation

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

removeHierarchy

removeHierarchy(hiearchyId: string): void
Parameters
- hiearchyId: string
Returns void
- Defined in src/model/ontology.ts:79
removeHierarchy(hiearchyId: Hierarchy): void
Parameters
- hiearchyId: Hierarchy
Returns void
- Defined in src/model/ontology.ts:80

removeSubclassOf

removeSubclassOf(subclassIri: string | Iri, superclassIri: string | Iri): void
Parameters
- subclassIri: string | Iri
- superclassIri: string | Iri
Returns void
- Defined in src/model/ontology.ts:193
removeSubclassOf(subclass: GrapholEntity, superclass: GrapholEntity): void
Parameters
- subclass: GrapholEntity
- superclass: GrapholEntity
Returns void
- Defined in src/model/ontology.ts:194

Class Ontology

Ontology

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

name: string

version: string

Optional iri: string

namespaces: Namespace[] = []

annProperties: AnnotationProperty[] = []

diagrams: Diagram[] = []

Returns Ontology

Properties

Private _entities

Private _hierarchies

Private _inclusions

Private _subHierarchiesMap

Private _superHierarchiesMap

annProperties

Optional defaultLanguage

Memberof

diagrams

Optional iri

Memberof

languages

Memberof

name

Memberof

namespaces

Memberof

ontologyEntity

usedColorScales

version

Memberof

Accessors

annotations

Memberof

Parameters

annotations: Annotation[]

Returns void

annotationsDiagram

Returns undefined | AnnotationsDiagram

entities

Returns Map<string, GrapholEntity>

Parameters

newEntities: Map<string, GrapholEntity>

Returns void

isEntitiesEmpty

Returns boolean

Methods

addAnnotation

Parameters

newAnnotation: Annotation

Returns void

addAnnotationProperty

Parameters

annProperty: AnnotationProperty

Returns void

addDiagram

Parameters

diagram: Diagram

Returns void

addEntity

Parameters

entity: GrapholEntity

Returns void

addHierarchy

Parameters

hierarchy: Hierarchy

Returns void

addNamespace

Parameters

namespace: Namespace

`Optional` iri: string

`Private` _entities

`Private` _hierarchies

`Private` _inclusions

`Private` _subHierarchiesMap

`Private` _superHierarchiesMap

`Optional` defaultLanguage

`Optional` iri

`Optional` language: string

`Optional` annotationProperty: Iri

`Optional` language: string

`Optional` diagramId: number

`Optional` renderState: RendererStatesEnum

`Optional` diagramId: number

`Optional` diagramId: number