-
Notifications
You must be signed in to change notification settings - Fork 206
/
m_predicate.html
135 lines (113 loc) · 7.9 KB
/
m_predicate.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Module m_predicate</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
</head>
<body bgcolor="white">
<div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<hr>
<h1>Module m_predicate</h1>
<ul class="index"><li><a href="#description">Description</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>Model for predicates.
<p>Copyright © 2009 Marc Worrell
Date: 2009-04-09
</p>
<p><b>Behaviours:</b> <a href="gen_model.html"><tt>gen_model</tt></a>.</p>
<p><b>Authors:</b> Marc Worrell (<a href="mailto:marc@worrell.nl"><tt>marc@worrell.nl</tt></a>).</p>
<h2><a name="description">Description</a></h2>Model for predicates
<h2><a name="index">Function Index</a></h2>
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#all-1">all/1</a></td><td>Return the list of all predicates.</td></tr>
<tr><td valign="top"><a href="#flush-1">flush/1</a></td><td>Flush all cached data about predicates.</td></tr>
<tr><td valign="top"><a href="#for_subject-2">for_subject/2</a></td><td>Return the list of predicates that are valid for the given resource id.</td></tr>
<tr><td valign="top"><a href="#get-2">get/2</a></td><td>Return the definition of the predicate.</td></tr>
<tr><td valign="top"><a href="#id_to_name-2">id_to_name/2</a></td><td>Lookup the name of a predicate with an id.</td></tr>
<tr><td valign="top"><a href="#insert-2">insert/2</a></td><td>Insert a new predicate, sets some defaults.</td></tr>
<tr><td valign="top"><a href="#is_predicate-2">is_predicate/2</a></td><td>Test if the property is the name of a predicate.</td></tr>
<tr><td valign="top"><a href="#m_find_value-3">m_find_value/3</a></td><td>Fetch the value for the key from a model source.</td></tr>
<tr><td valign="top"><a href="#m_to_list-2">m_to_list/2</a></td><td>Transform a model value to a list, used for template loops.</td></tr>
<tr><td valign="top"><a href="#m_value-2">m_value/2</a></td><td>Transform a model value so that it can be formatted or piped through filters.</td></tr>
<tr><td valign="top"><a href="#name_to_id-2">name_to_id/2</a></td><td>Return the id of the predicate.</td></tr>
<tr><td valign="top"><a href="#name_to_id_check-2">name_to_id_check/2</a></td><td></td></tr>
<tr><td valign="top"><a href="#object_category-2">object_category/2</a></td><td>Return all the valid categories for objects.</td></tr>
<tr><td valign="top"><a href="#objects-2">objects/2</a></td><td>Return the category ids that are valid as objects.</td></tr>
<tr><td valign="top"><a href="#subject_category-2">subject_category/2</a></td><td>Return all the valid categories for subjects.</td></tr>
<tr><td valign="top"><a href="#subjects-2">subjects/2</a></td><td>Return the category ids that are valid as subjects.</td></tr>
<tr><td valign="top"><a href="#update_noflush-4">update_noflush/4</a></td><td>Update a predicate, save the reversed flag, reset the list of valid subjects and objects.</td></tr>
</table>
<h2><a name="functions">Function Details</a></h2>
<h3 class="function"><a name="all-1">all/1</a></h3>
<div class="spec">
<p><tt>all(Context) -> PropList</tt><br></p>
</div><p>Return the list of all predicates</p>
<h3 class="function"><a name="flush-1">flush/1</a></h3>
<div class="spec">
<p><tt>flush(Context) -> any()</tt></p>
</div><p>Flush all cached data about predicates.</p>
<h3 class="function"><a name="for_subject-2">for_subject/2</a></h3>
<div class="spec">
<p><tt>for_subject(Id, Context) -> any()</tt></p>
</div><p>Return the list of predicates that are valid for the given resource id. Append all predicates that have no restrictions.</p>
<h3 class="function"><a name="get-2">get/2</a></h3>
<div class="spec">
<p><tt>get(PredId, Context) -> PredicatePropList | undefined</tt><br></p>
</div><p>Return the definition of the predicate</p>
<h3 class="function"><a name="id_to_name-2">id_to_name/2</a></h3>
<div class="spec">
<p><tt>id_to_name(Id, Context) -> {ok, atom()} | {error, Reason}</tt><br></p>
</div><p>Lookup the name of a predicate with an id</p>
<h3 class="function"><a name="insert-2">insert/2</a></h3>
<div class="spec">
<p><tt>insert(Title, Context) -> {ok, Id} | {error, Reason}</tt><br></p>
</div><p>Insert a new predicate, sets some defaults.</p>
<h3 class="function"><a name="is_predicate-2">is_predicate/2</a></h3>
<div class="spec">
<p><tt>is_predicate(Id::Pred, Context) -> bool()</tt><br></p>
</div><p>Test if the property is the name of a predicate</p>
<h3 class="function"><a name="m_find_value-3">m_find_value/3</a></h3>
<div class="spec">
<p><tt>m_find_value(Key, M::Source, Context) -> term()</tt><br></p>
</div><p>Fetch the value for the key from a model source</p>
<h3 class="function"><a name="m_to_list-2">m_to_list/2</a></h3>
<div class="spec">
<p><tt>m_to_list(M::Source, Context) -> List</tt><br></p>
</div><p>Transform a model value to a list, used for template loops</p>
<h3 class="function"><a name="m_value-2">m_value/2</a></h3>
<div class="spec">
<p><tt>m_value(M::Source, Context) -> term()</tt><br></p>
</div><p>Transform a model value so that it can be formatted or piped through filters</p>
<h3 class="function"><a name="name_to_id-2">name_to_id/2</a></h3>
<div class="spec">
<p><tt>name_to_id(Name::Pred, Context) -> {ok, <a href="#type-int">int()</a>} | {error, Reason}</tt><br></p>
</div><p>Return the id of the predicate</p>
<h3 class="function"><a name="name_to_id_check-2">name_to_id_check/2</a></h3>
<div class="spec">
<p><tt>name_to_id_check(Name, Context) -> any()</tt></p>
</div>
<h3 class="function"><a name="object_category-2">object_category/2</a></h3>
<div class="spec">
<p><tt>object_category(Id, Context) -> List</tt><br></p>
</div><p>Return all the valid categories for objects. Return the empty list when there is no constraint. Note that the resulting array
is a bit strangely formatted [{id}, {id2}, ...], this is compatible with the category name lookup and prevents mixups with strings (lists of integers).</p>
<h3 class="function"><a name="objects-2">objects/2</a></h3>
<div class="spec">
<p><tt>objects(Id, Context) -> any()</tt></p>
</div><p>Return the category ids that are valid as objects</p>
<h3 class="function"><a name="subject_category-2">subject_category/2</a></h3>
<div class="spec">
<p><tt>subject_category(Id, Context) -> List</tt><br></p>
</div><p>Return all the valid categories for subjects. Return the empty list when there is no constraint. Note that the resulting array
is a bit strangely formatted [{id}, {id2}, ...], this is compatible with the category name lookup and prevents mixups with strings (lists of integers).</p>
<h3 class="function"><a name="subjects-2">subjects/2</a></h3>
<div class="spec">
<p><tt>subjects(Id, Context) -> any()</tt></p>
</div><p>Return the category ids that are valid as subjects</p>
<h3 class="function"><a name="update_noflush-4">update_noflush/4</a></h3>
<div class="spec">
<p><tt>update_noflush(Id, Subjects, Objects, Context) -> <a href="#type-void">void()</a></tt><br></p>
</div><p>Update a predicate, save the reversed flag, reset the list of valid subjects and objects.</p>
<hr>
<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Apr 11 2012, 20:41:29.</i></p>
</body>
</html>