webAi.WebSrch - リファレンス

説明

Web AI」は、クロノス・クラウンの柳井政和が開発しているJavaScirptのライブラリです。「Web AI」を使うと、Web上からデータを取得して構築するWebページを、とても簡単に構築することができます。

「Web AI」は、Webからの検索結果やフィードの取得、短縮URLへのURLの変換、日本語文章からのキーワードや文章抽出、日本語文章のマルコフ連鎖、クエリーの管理などの機能を備えています。

このページでは、この「Web AI」のファイルの1つである「crocro.webAi.WebSrch.js」のリファレンスを掲載します。このリファレンスは、クロノス・クラウン 柳井政和開発の「easyJsDoc」で作成しています。

リファレンス

publiccrocro.webAi.WebSrch()検索用オブジェクト
publicWebSrch.srchPrms検索オブジェクト
publicWebSrch.isExec実行中か否か
publicWebSrch.intrvlインターバル
publicWebSrch.ready(fnc)google検索オブジェクト・ロード後のコールバック
publicWebSrch.reset()命令のリセット
publicWebSrch.start()命令の開始
publicWebSrch.pushCmnds(arg)命令の登録
publicWebSrch.insrtOn()挿入モードを有効に
publicWebSrch.insrtOff()挿入モードを無効に
publicWebSrch.setEachCall(arg)毎回処理追加
publicWebSrch.brand(arg)googleのブランド表示
publicWebSrch.init(arg)初期化処理
publicWebSrch.add(arg)追加処理
publicWebSrch.end(arg)終了処理
publicWebSrch.loopCntループのカウント
publicWebSrch.addCallback(arg)追加処理 コールバック
publicWebSrch.endCallback()追加処理 コールバック 終了時用
publicWebSrch.loopBreak()ループ終了
publicWebSrch.cmndsBreak()命令処理終了
publicWebSrch.srch(arg)検索
publicWebSrch.feed(arg)フィード検索
publicWebSrch.appndResTgt検索結果追加先の要素ID
publicWebSrch.appndResDeco検索結果追加の加工用関数
publicWebSrch.shrtUrl(arg)短縮URL
publicWebSrch.sgst(arg)Google Suggest
privateWebSrch.loadGgl(fnc, arg)googleローダーの読み込み
privateWebSrch.initExecVar()実行設定の初期化
privateWebSrch.nextExec()命令の逐次実行処理
privateWebSrch.getPrm(arg)値の取得
privateWebSrch.getIntrvl()インターバルの取得
privateWebSrch.doSetEachCall(arg)毎回処理追加 実行
privateWebSrch.doBrand(arg)googleのブランド表示 実行
privateWebSrch.doInit(arg)初期化処理 実行
privateWebSrch.loadGglJS(typ, ver, fnc, arg)Googleオブジェクトのロード
privateWebSrch.loadJS(typ, ver, fnc, arg)JSのロード
privateWebSrch.doAdd(arg)追加処理 実行
privateWebSrch.doEnd(arg)追加処理 実行
privateWebSrch.doAddCallback(arg)追加処理 コールバック 実行
privateWebSrch.initNowArg(arg)現在引数の初期化
privateWebSrch.loopUnable()ループ無効
privateWebSrch.doSrch(arg)検索 実行
privateWebSrch.doPage()検索 ページング
privateWebSrch.doFeed(arg)フィード検索 実行
privateWebSrch.appndRes()結果追加
privateWebSrch.doShrtUrl(arg)短縮URL 実行
privateWebSrch.doSgst(arg)Google Suggest 実行
public
crocro.webAi.WebSrch()
検索用オブジェクト
検索用オブジェクト。主に、「Google AJAX Search API」を使いやすくすることを目的としている。メソッド・チェーンで、初期化や検索、その結果の処理などを記述できる。newで初期化してから利用する。

「reset」メソッドで予約をクリアして、各種メソッドで予約の登録を行った後、「start」メソッドで、予約した処理を順番に実行していく。

「start」を呼び出すまでは実行は行われないので、ユーザーの操作をいくつか受け付けた後に、実行ボタンで処理を開始するようなことも可能。

例)
var g = new crocro.webAi.WebSrch();
g
.reset() // 予約のクリア
.hoge() // 命令の追加
.hoge() // 命令の追加
.hoge() // 命令の追加
.start(); // 追加した命令を実行

実際の用法は、サンプルコードを参照。
public
WebSrch.srchPrms
検索オブジェクト
「web: {obj: null, init: function() {return new google.search.WebSearch();}}」の形式の配列。この場合、「WebSrch.init」メソッドで「web」を指定すると、「web.obj」に「web.init()」の戻り値が登録される。

デフォルトで「web」「img」「nws」「blg」が設定されている。配列にオブジェクトを追加することで、他の検索も利用することができる。

詳しくはソースコードを参照。
public
WebSrch.isExec
実行中か否か
命令が実行中の間は「true」が格納されている。二重起動防止などの判定用に利用する。

詳しくはサンプルのソースコードを参照。
public
WebSrch.intrvl
インターバル
処理の実行インターバル。数値か、数値を戻す関数を設定する。

通信の負荷を軽減するために、1秒に一度実行を行うなどの用途で利用する。

デフォルトは「0」。
public
WebSrch.ready(fnc)
google検索オブジェクト・ロード後のコールバック
「google.setOnLoadCallback」と等価。短縮表記用。

HTMLページ読み込み直後に処理を行う際は、この関数の引数に、処理を行う関数をセットして実行させる。

また、HTMLページ読み込み直後には、「init」だけ行っておき、その後の検索処理は、ボタンクリックなどのイベント発生時に行わせてもよい。

param   fnc  検索オブジェクト・ロード後に実行させる関数。
return  なし(メソッド・チェーン不可)。
private
WebSrch.loadGgl(fnc, arg)
googleローダーの読み込み
googleローダーがまだ初期化されていなければ、googleローダーを読み込む。

return  なし。
public
WebSrch.reset()
命令のリセット
登録していた命令を全て削除する。

return  this(メソッドチェーン可能)。
public
WebSrch.start()
命令の開始
登録していた命令を全て実行する。命令の開始は、非同期で開始される。メソッド・チェーンの末尾に記述するメソッド。

return  なし(メソッド・チェーン不可)。
private
WebSrch.initExecVar()
実行設定の初期化
実行用変数の初期化

return  なし。
private
WebSrch.nextExec()
命令の逐次実行処理
登録していた命令を1つずつ実行する。内部処理用のメソッド。外部からの呼び出しは行わない。

return  なし。
public
WebSrch.pushCmnds(arg)
命令の登録
命令を登録する。通常時は、命令は末尾に追加していく。挿入モードがオンの場合は、現在実行位置の次の位置に、次々と追加していく。

param   arg  引数となるオブジェクト。
return  取得した値。
private
WebSrch.getPrm(arg)
値の取得
引数などに使うオブジェクトから値を取得する。文字列や数値なら、その値をそのまま返し、関数なら戻り値を返す。

param   obj  値を取得するオブジェクト。
return  取得した値。
private
WebSrch.getIntrvl()
インターバルの取得
インターバル用のオブジェクトから数値を取得する。文字列や数値なら、数値を戻し、関数なら戻り値を数値化して戻す。

return  インターバルの取得。
public
WebSrch.insrtOn()
挿入モードを有効に
挿入モードを有効にする。これ以降、挿入モードを無効にするまで、現在実行位置の直後に、次々と命令を追加していく。

※この命令は、呼び出された瞬間に効果を発揮する。 命令の登録ではなく、単なるモードの変更である。

return  this(メソッドチェーン可能)。
public
WebSrch.insrtOff()
挿入モードを無効に
挿入モードを無効にする。これ以降、命令を追加すると、末尾に追加されていく。

※この命令は、呼び出された瞬間に効果を発揮する。 命令の登録ではなく、単なるモードの変更である。

return  this(メソッドチェーン可能)。
public
WebSrch.setEachCall(arg)
毎回処理追加
ステップごとに呼び出される処理を追加する。

param   arg  関数。
return  this(メソッドチェーン可能)。
private
WebSrch.doSetEachCall(arg)
毎回処理追加 実行
ステップごとに呼び出される処理を追加する。

param   arg  関数。
return  this(メソッドチェーン可能)。
public
WebSrch.brand(arg)
googleのブランド表示
ブランド表示を行う、表示先のエレメントIDを引数として指定する。

param   arg  エレメントのID。
return  this(メソッドチェーン可能)。
private
WebSrch.doBrand(arg)
googleのブランド表示 実行
登録した「brand」命令の実行。

param   arg  追加実行する関数オブジェクト。
return  なし。
public
WebSrch.init(arg)
初期化処理
Google検索オブジェクトの初期化処理を行う。

param   arg.type  種類を指定(web, img, nws)
param   arg.opt   検索オブジェクトを受け取る関数を指定。この関数の中で、Google検索オブジェクトの追加の設定を行う。
return  this(メソッドチェーン可能)。
private
WebSrch.doInit(arg)
初期化処理 実行
登録した「init」命令の実行。

param   arg  追加実行する関数オブジェクト。
return  なし。
private
WebSrch.loadGglJS(typ, ver, fnc, arg)
Googleオブジェクトのロード
Googleオブジェクトが初期化されていない場合に読み込む処理。

param   typ  読み込むオブジェクト。
param   ver  バージョン。
param   fnc  追加実行する関数。
param   arg  追加実行する関数の引数。
return  なし。
private
WebSrch.loadJS(typ, ver, fnc, arg)
JSのロード
外部JavaScriptを読み込む処理。外部JavaScriptのオブジェクトが初期化されていない場合に利用する。

param   url  読み込む外部JavaScriptのURL。
param   fnc  追加実行する関数。
param   arg  追加実行する関数の引数。
return  なし。
public
WebSrch.add(arg)
追加処理
引数として、追加実行する関数を指定。

param   arg  追加実行する関数オブジェクト。
return  this(メソッドチェーン可能)。
private
WebSrch.doAdd(arg)
追加処理 実行
登録した「add」命令の実行。

param   arg  追加実行する関数オブジェクト。
return  なし。
public
WebSrch.end(arg)
終了処理
命令の実行処理を終了する。

param   arg  追加実行する関数オブジェクト。
return  this(メソッドチェーン可能)。
private
WebSrch.doEnd(arg)
追加処理 実行
登録した「add」命令の実行。

param   arg  追加実行する関数オブジェクト。
return  なし。
public
WebSrch.loopCnt
ループのカウント
検索などのループ指定を行える処理の場合に、現在のループ回数を取得するための変数。

詳しくはサンプルのソースコードを参照。
public
WebSrch.addCallback(arg)
追加処理 コールバック
引数として、コールバック付きの追加実行する関数を指定。このメソッド内で行うコールバック処理が終わったタイミングで、「endCallback」を呼び出す。そうすれば、次の命令に移動して実行が継続される。

param   arg.init  ループ実行前の処理を関数で指定。
param   arg.loop  ループ回数の数字か関数を指定。
param   arg.exec  処理を行う関数を指定。
return  this(メソッドチェーン可能)。
private
WebSrch.doAddCallback(arg)
追加処理 コールバック 実行
登録した「addCallback」命令の実行。

param   arg  追加実行する関数オブジェクト。
return  なし。
private
WebSrch.initNowArg(arg)
現在引数の初期化
コールバック系処理の、現在引数を初期化する。

param   arg  追加実行する関数オブジェクト
return  なし。
private
WebSrch.loopUnable()
ループ無効
ループ無効時の処理。カウントを初期値にして、次の命令に移行する。

return  なし(メソッドチェーン不可)。
public
WebSrch.endCallback()
追加処理 コールバック 終了時用
登録した「addCallback」命令の終了時に呼び出すメソッド。この命令が呼ばれると、次の処理が実行される。

return  なし。
public
WebSrch.loopBreak()
ループ終了
ループ処理中で、ループを打ち切るフラグを立てるためのメソッド。

return  なし(メソッドチェーン不可)。
public
WebSrch.cmndsBreak()
命令処理終了
命令処理中に、条件に応じて全ての処理を終了するためのメソッド。これ以降の命令を全て無効にして、現在実行中の処理までで終了する。

return  なし(メソッドチェーン不可)。
public
WebSrch.srch(arg)
検索
検索の種類とループ回数を指定して、検索を行う。検索は、実行毎に「arg.key」の引数で指定した関数の戻り値を検索語として利用する。検索の結果は、「arg.res」の引数で指定した関数の戻り値として受け取る。

param   arg.init  ループ実行前の処理を関数で指定。
param   arg.loop  ループの回数を指定。
param   arg.type  種類を指定(web, img, nws, blg)。
param   arg.page  検索結果のページを、何ページ分取得するか指定。
param   arg.key   戻り値にキーワードを返す関数を指定。
param   arg.res   結果を受け取る関数を指定。
return  this(メソッドチェーン可能)。
private
WebSrch.doSrch(arg)
検索 実行
登録した「srch」命令の実行。

param   arg  追加実行する関数オブジェクト。
return  なし。
private
WebSrch.doPage()
検索 ページング
登録した「srch」のページ処理を行うためのメソッド。

return  なし。
public
WebSrch.feed(arg)
フィード検索
RSSフィードをJSONにして取得する。

param   arg.init  ループ実行前の処理を関数で指定。
param   arg.loop  ループ回数の数字か関数を指定。
param   arg.url   読み込むRSSのURLを関数の戻り値として指定。
param   arg.res   結果を受け取る関数を指定。
return  this(メソッドチェーン可能)。
private
WebSrch.doFeed(arg)
フィード検索 実行
登録した「feed」命令の実行。

param   arg  追加実行する関数オブジェクト
return  なし。
public
WebSrch.appndResTgt
検索結果追加先の要素ID
検索が行われるとごとに、検索結果を出力させるために使用。要素IDを指定する。

デフォルトは空文字(指定なし)。

詳しくはサンプルのソースコードを参照。
public
WebSrch.appndResDeco
検索結果追加の加工用関数
検索が行われるとごとに、検索結果を出力させるために使用。出力を加工するための関数を指定。

デフォルトはnull。

詳しくはサンプルのソースコードを参照。
private
WebSrch.appndRes()
結果追加
検索が行われるごとに、検索結果を出力するために呼び出される内部関数。

return  なし。
public
WebSrch.shrtUrl(arg)
短縮URL
短縮URLの作成を行う。

param   arg.init  ループ実行前の処理を関数で指定。
param   arg.loop  ループ回数の数字か関数を指定。
param   arg.url   変換を行うURLの文字列か関数を指定。
param   arg.res   結果を受け取る関数を指定。
return  this(メソッドチェーン可能)。
private
WebSrch.doShrtUrl(arg)
短縮URL 実行
登録した「shrtUrl」命令の実行。

param   arg  追加実行する関数オブジェクト。
return  なし。
public
WebSrch.sgst(arg)
Google Suggest
Google Suggestを利用して、関連語の取得を行う。

戻り値を受け取る「arg.res」関数は、1つの連想配列を引数として受け取る。この引数の連想配列の内容は以下の通り。

「res : function(res) {}」の場合

res.jsonp …… 取得したJSONPの生データ。
res.raw …… 取得したデータ部分の生配列。
res.wrd …… 取得したデータを単語の配列にしたもの。以降のデータは、半角スペースが入った文字列は分割して格納。
res.hd …… 検索文字を先頭に含む文字列配列(hd = head)。「本」で検索して「本と私」という結果があれば「本と私」を格納。
res.not …… 検索文字を含まない単語配列。「本」で検索して「本と私」という結果があれば無視する。


検索語の末尾に半角スペースを入れると、関連語の一覧が取得できる。その際は「res.not」を使って関連語のリストを取得するとよい。

検索語の末尾に半角スペースを入れるなければ、その語に続く文章が取得できる。その際は「res.hd」を使って文字列を取得するとよい。

param   arg.init  ループ実行前の処理を関数で指定。
param   arg.loop  ループ回数の数字か関数を指定。
param   arg.kw    検索するキーワードの文字列か関数を指定。
param   arg.res   結果を受け取る関数を指定。
return  this(メソッドチェーン可能)。
private
WebSrch.doSgst(arg)
Google Suggest 実行
登録した「doSgst」命令の実行。

param   arg  追加実行する関数オブジェクト。
return  なし。
Cronus Crown(クロノス・クラウン)のトップページに戻る
(c)2002-2017 Cronus Crown (c)1997-2017 Masakazu Yanai
このWebPageに関するご意見・お問い合わせは
サイト情報 弊社への連絡
までお願いします。