Heracles.ts

@hydra-cg/heracles.ts > TemplatedResource

Class: TemplatedResource

Provides a base functionality for resources that has expandable template.

class:

Type parameters

T : IPointingResource

Hierarchy

TemplatedResource

↳ TemplatedLink

↳ TemplatedOperation

Implements

• ITemplatedResource<T>

Index

Constructors

• constructor

Properties

• baseUrl
• collections
• iri
• links
• mappings
• operations
• target
• template
• type

Methods

• createInstance
• expandTarget
• getNextIri

---

Constructors

<Protected> constructor

⊕ new TemplatedResource(resource: IPointingResource, template: IIriTemplate, type: Iterable<string>): TemplatedResource

Defined in DataModel/TemplatedResource.ts:43

Initializes a new instance of the TemplatedOperation class.

Parameters:

Name	Type	Description
resource	IPointingResource	Original resource to create templated one from.
template	IIriTemplate	IRI template to take template from.
type	Iterable<string>	Types of the resource.

Returns: TemplatedResource

---

Properties

baseUrl

● baseUrl: string

Implementation of ITemplatedResource.baseUrl

Defined in DataModel/TemplatedResource.ts:22

Gets a base URL that can be used to resolve target in case it is relative.

readonly:

returns:

---

collections

● collections: ResourceFilterableCollection<ICollection>

Implementation of ITemplatedResource.collections

Defined in DataModel/TemplatedResource.ts:40

Gets collections exposed by that resource.

readonly:

returns:

---

iri

● iri: string

Implementation of ITemplatedResource.iri

Defined in DataModel/TemplatedResource.ts:25

Gets an Iri of a resource.

readonly:

returns:

---

links

● links: LinksCollection

Implementation of ITemplatedResource.links

Defined in DataModel/TemplatedResource.ts:37

Gets links related to that resource.

readonly:

returns:

---

<Private> mappings

● mappings: MappingsCollection

Defined in DataModel/TemplatedResource.ts:43

---

operations

● operations: OperationsCollection

Implementation of ITemplatedResource.operations

Defined in DataModel/TemplatedResource.ts:34

Gets operations that can be performed on that resource.

readonly:

returns:

---

target

● target: IResource

Implementation of ITemplatedResource.target

Defined in DataModel/TemplatedResource.ts:31

Gets a target URL to be called.

readonly:

returns:

---

<Private> template

● template: string

Defined in DataModel/TemplatedResource.ts:42

---

type

● type: TypesCollection

Implementation of ITemplatedResource.type

Defined in DataModel/TemplatedResource.ts:28

Gets classes a given resource is of.

readonly:

returns:

---

Methods

<Protected><Abstract> createInstance

▸ createInstance(resource: IPointingResource): T

Defined in DataModel/TemplatedResource.ts:92

Creates a new instance of the object of type T.

Parameters:

Name	Type	Description
resource	IPointingResource	Resource to act as a bag of initial values.

Returns: T

---

expandTarget

▸ expandTarget(mappedVariables: IDictionary<string> | MappingBuilder): T

Implementation of ITemplatedResource.expandTarget

Defined in DataModel/TemplatedResource.ts:64

Expands an URI template with given variables.

Parameters:

Name	Type
mappedVariables	IDictionary<string> | MappingBuilder

Returns: T

---

<Protected><Abstract> getNextIri

▸ getNextIri(): string

Defined in DataModel/TemplatedResource.ts:98

Gets a next IRI.

Returns: string

---

This site is open source. Improve this page.