occi_kind.md

Module occi_kind

• Description
• Data Types
• Function Index
• Function Details

.

Copyright (c) (C) 2016, Jean Parpaillon

Authors: Jean Parpaillon (jean.parpaillon@free.fr).

Data Types

t()

abstract datatype: t()

Function Index

from_map/1	Build kind from AST.
has_parent/2	Return true if kind has the parent.
known_parent/1	Return first known parent.
new/2
parent/1	Return parent of the category.
parent/2	Set parent of the category.
parents/1	Return all ancestors.
parents/2	Set full list of parents.

Function Details

from_map/1

from_map(Map::occi_rendering:ast()) -> t()

Build kind from AST

has_parent/2

has_parent(Parent::occi_category:id() | resource | link, Kind::t()) -> boolean()

Return true if kind has the parent

known_parent/1

known_parent(Kind::t()) -> resource | entity

Return first known parent

new/2

new(Scheme::binary(), Term::binary()) -> t()

parent/1

parent(Kind::t()) -> occi_category:id() | undefined

Return parent of the category

parent/2

parent(Parent::binary() | occi_category:id(), Kind::t()) -> t()

Set parent of the category

parents/1

parents(Kind::t()) -> [occi_category:id()]

Return all ancestors

parents/2

parents(Parents::[occi_category:id()], Kind::t()) -> t()

Set full list of parents