Class: HmxClient::Command::View

Inherits:
Base
  • Object
show all
Defined in:
lib/hmx/command/view.rb

Overview

Display the results of a view and list all views

Constant Summary

Constants inherited from Base

Base::FILE

Instance Attribute Summary

Attributes inherited from Base

#args, #options

Instance Method Summary collapse

Methods inherited from Base

#hmx, #initialize, #loadConfig!, namespace, #removeConfig, #storeConfig, #writeConfig

Methods included from Helpers

#display, #display_row, #display_table, #error, #getFromUser, #longest

Constructor Details

This class inherits a constructor from HmxClient::Command::Base

Instance Method Details

#create ⇒ Object

view:create

Create a new (initially blank) view. You will then need to call update to set the filter function, map function, query params and result columns.

Views are based on types, for create define a name and the type



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/hmx/command/view.rb', line 58

def create
  unless args.size > 1
    raise CommanFailed, "Usage: hmx view:create <viewName> <typeName>"
  end
  view = args.shift
  viewName = "sys.view/#{view}"
  typeName = args.shift
  
  dataDocument = { 
                          "MXView" => {
                              :typeName => typeName,
                              :parameterNames => [],
                              :filterFn => "",
                              :mappingFn => "",
                              :resultColumns => [],
                              :viewName => view
                          }
               }

  dout JSON.pretty_generate(hmx.putSimpleData([viewName, JSON.generate(dataDocument)]))
end

#delete ⇒ Object

view:delete

Delete a view definition



145
146
147
148
149
150
151
152
 
# File 'lib/hmx/command/view.rb', line 145

def delete
  unless args.size >0 
   raise CommandFailed, "Usage: hmx view:delete <viewName>"
  end
  view = args.shift
  viewName = "sys.view/#{view}"
  display hmx.deleteData(viewName)
end

#get ⇒ Object

view:get

Retrieves the definition of a view



42
43
44
45
46
47
48
49
 
# File 'lib/hmx/command/view.rb', line 42

def get
   unless args.size > 0
    raise CommandFailed, "Usage: hmx view:get <viewName>" 
  end
  typeName = "sys.view/#{args.shift}"
  display "Retrieving #{ typeName }"
  dout JSON.pretty_generate(hmx.getData([typeName]))
end

#index ⇒ Object

view

run a view in hmx, passing in a view name and an input to the filter function



14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/hmx/command/view.rb', line 14

def index
  unless args.size > 0
    raise CommandFailed, "Usage: hmx view <viewName> <filterContext>" 
  end
  viewData = hmx.runView(args.shift, JSON.parse(args.shift))
  resp = ''
  viewData.each { | line | 
                     line.each { | cell | resp = resp + "%20.20s\t" % cell }
                     resp = resp + "\n"
                }
  dout resp
end

#list ⇒ Object

view:list

Lists all of the views in the system



31
32
33
34
35
36
 
# File 'lib/hmx/command/view.rb', line 31

def list
  views = hmx.query("sys.view", nil)
  views.each { | v |
             display v.rpartition('/')[2]
            } 
end

#updateFilter ⇒ Object

view:updateFilter

Set the filter function for a view



84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/hmx/command/view.rb', line 84

def updateFilter
  unless args.size > 1
   raise CommandFailed, "Usage: hmx view:updateFilter <viewName> <filterFn>"
  end
  view = args.shift
  viewName = "sys.view/#{view}"
  filterFn = args.shift

  dataDocument = hmx.getData([viewName])
  puts dataDocument
  dataDocument['document']['MXView']['filterFn'] = filterFn
  display hmx.putData([JSON.generate(dataDocument)])
end

#updateMap ⇒ Object

view:updateMap

Set the map function for a view



101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/hmx/command/view.rb', line 101

def updateMap
  unless args.size > 1
   raise CommandFailed, "Usage: hmx view:updateMap <viewName> <filterFn>"
  end
  view = args.shift
  viewName = "sys.view/#{view}"
  mapFn = args.shift
  dataDocument = hmx.getData([viewName])
  dataDocument['document']['MXView']['mappingFn'] = mapFn
  display hmx.putData([JSON.generate(dataDocument)])
end

#updateParam ⇒ Object

view:updateParam

Set the parameter names for a view



116
117
118
119
120
121
122
123
124
125
 
# File 'lib/hmx/command/view.rb', line 116

def updateParam
  unless args.size > 1
   raise CommandFailed, "Usage: hmx view:updateParam <viewName> <param> [<param2> ...]"
  end
  view = args.shift
  viewName = "sys.view/#{view}"
  dataDocument = hmx.getData([viewName])
  dataDocument['document']['MXView']['parameterNames'] = args
  display hmx.putData([JSON.generate(dataDocument)])
end

#updateResult ⇒ Object

view:updateResult

Set the result names for a view



130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/hmx/command/view.rb', line 130

def updateResult
  unless args.size > 1
   raise CommandFailed, "Usage: hmx view:updateResult <viewName> <param> [<param2> ...]"
  end
  view = args.shift
  viewName = "sys.view/#{view}"

  dataDocument = hmx.getData([viewName])
  dataDocument['document']['MXView']['resultColumns'] = args
  display hmx.putData([JSON.generate(dataDocument)])
end