mokkouyou.yahoo.query
クラス WebQuery

java.lang.Object
  拡張mokkouyou.yahoo.query.WebQuery

public class WebQuery
extends java.lang.Object

ウェブ検索で使用するクエリ付きURLを生成する。
入力チェックは行わない。
必要な値を設定した後にcreateQueryString()を呼ぶ。

バージョン:
1.0

コンストラクタの概要
WebQuery()
           
 
メソッドの概要
 void clearAdult()
          key adult_okを初期値に戻す。
 void clearApplId()
          key appIdを初期値に戻す。
 void clearCountry()
          key countryを初期値に戻す
 void clearFormat()
          key formatを初期値に戻す。
 void clearLanguage()
           
 void clearQuery()
          key queryを初期に値に戻す。
 void clearResultCount()
          key result を初期値に戻す。
 void clearSimilar()
          key similarを初期値に戻す。
 void clearSite()
          key siteを初期値に戻す。
 void clearStart()
          key startを初期値に戻す。
 void clearType()
          key typeを初期値に戻す。
 java.lang.String createQueryString()
          設定した値を元にクエリを構築する。
 java.lang.String getAdult()
          adult_ok 値なし(デフォルト), 1
アダルトコンテンツの検索結果を含めるかどうかを取得。
 java.lang.String getApplId()
          アプリケーションID
 java.lang.String getCountry()
          country string: 値なし(デフォルト) ウェブサイトが位置する国の国コードです。
 java.lang.String getFormat()
          format any(デフォルト), html, msword, pdf, ppt, rss, txt, xls
検索するファイルの種類を指定します。
 java.lang.String getLanguage()
          language string: ja(デフォルト)
languageで書かれた結果になります。
 java.lang.String getQuery()
          必須 (UTF-8エンコードされた)検索クエリーです。
 java.lang.String getResultCount()
          integer: 10(デフォルト), 50(最大)
返却結果の数です。
 java.lang.String getSimilar()
          similar_ok 値なし(デフォルト), 1
同じコンテンツを別の検索結果とするかどうかを指定します。
 java.lang.String getSite()
          site string: 値なし(デフォルト)
検索するドメイン(例えば www.mokkouyou.yahoo.co.jp)を制限します。
 java.lang.String getStart()
          start integer: 1(デフォルト)
返却結果の先頭位置(1 - based)です。
 java.lang.String getType()
          all(デフォルト), any, phrase
指定検索の種類:
allは全クエリー文字を含む検索結果を返します。
 void setAdult(WebQueryConst adult)
          adult_ok 値なし(デフォルト), 1
アダルトコンテンツの検索結果を含めるかどうかを指定します。
 void setApplId(java.lang.String applId)
          アプリケーションIDを指定する。
 void setCountry(java.lang.String country)
          country string: 値なし(デフォルト) ウェブサイトが位置する国の国コードです。
 void setFormat(WebQueryConst format)
          format any(デフォルト), html, msword, pdf, ppt, rss, txt, xls
検索するファイルの種類を指定します。
 void setLanguage(java.lang.String language)
          language string: ja(デフォルト)
languageで書かれた結果になります。
 void setQuery(java.lang.String query)
          必須 (UTF-8エンコードされた)検索クエリーです。
 void setResultCount(int resultCount)
          integer: 10(デフォルト), 50(最大)
返却結果の数です。
 void setSimilar(WebQueryConst similar)
          similar_ok 値なし(デフォルト), 1
同じコンテンツを別の検索結果とするかどうかを指定します。
 void setSite(java.lang.String site)
          site string: 値なし(デフォルト)
検索するドメイン(例えば www.mokkouyou.yahoo.co.jp)を制限します。
 void setStart(int start)
          start integer: 1(デフォルト)
返却結果の先頭位置(1 - based)です。
 void setType(WebQueryConst type)
          all(デフォルト), any, phrase
指定検索の種類:
allは全クエリー文字を含む検索結果を返します。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

WebQuery

public WebQuery()
メソッドの詳細

getAdult

public java.lang.String getAdult()
adult_ok 値なし(デフォルト), 1
アダルトコンテンツの検索結果を含めるかどうかを取得。
1の場合はアダルトコンテンツを含みます。

戻り値:
Returns the adult.

setAdult

public void setAdult(WebQueryConst adult)
adult_ok 値なし(デフォルト), 1
アダルトコンテンツの検索結果を含めるかどうかを指定します。
1の場合はアダルトコンテンツを含みます。

パラメータ:
adult - adult を設定する。

clearAdult

public void clearAdult()
key adult_okを初期値に戻す。


getApplId

public java.lang.String getApplId()
アプリケーションID

戻り値:
Returns the applId.

setApplId

public void setApplId(java.lang.String applId)
アプリケーションIDを指定する。

パラメータ:
applId - applId を設定する。

clearApplId

public void clearApplId()
key appIdを初期値に戻す。


getCountry

public java.lang.String getCountry()
country string: 値なし(デフォルト) ウェブサイトが位置する国の国コードです。
「サポートしている国・地域」
アメリカ us
アルゼンチン ar
イギリス uk
イタリア it
オランダ nl
オーストラリア au
オーストリア at
カナダ ca
韓国 kr
スイス ch
スウェーデン se
スペイン es
台湾 tw
チェコ cz
中国 cn
デンマーク dk
ドイツ de
日本 jp
ノルウェー no
フィンランド fi
フランス fr
ブラジル br
ベルギー be
ポーランド pl
ロシア ru

戻り値:
Returns the country.

setCountry

public void setCountry(java.lang.String country)
country string: 値なし(デフォルト) ウェブサイトが位置する国の国コードです。
「サポートしている国・地域」
アメリカ us
アルゼンチン ar
イギリス uk
イタリア it
オランダ nl
オーストラリア au
オーストリア at
カナダ ca
韓国 kr
スイス ch
スウェーデン se
スペイン es
台湾 tw
チェコ cz
中国 cn
デンマーク dk
ドイツ de
日本 jp
ノルウェー no
フィンランド fi
フランス fr
ブラジル br
ベルギー be
ポーランド pl
ロシア ru

パラメータ:
country - country を設定する。

clearCountry

public void clearCountry()
key countryを初期値に戻す


getFormat

public java.lang.String getFormat()
format any(デフォルト), html, msword, pdf, ppt, rss, txt, xls
検索するファイルの種類を指定します。

戻り値:
Returns the format.

setFormat

public void setFormat(WebQueryConst format)
format any(デフォルト), html, msword, pdf, ppt, rss, txt, xls
検索するファイルの種類を指定します。

パラメータ:
format - format を設定する。

clearFormat

public void clearFormat()
key formatを初期値に戻す。


getLanguage

public java.lang.String getLanguage()
language string: ja(デフォルト)
languageで書かれた結果になります。
「サポートしている言語」
アメリカ us
アルゼンチン ar
イギリス uk
イタリア it
オランダ nl
オーストラリア au
オーストリア at
カナダ ca
韓国 kr
スイス ch
スウェーデン se
スペイン es
台湾 tw
チェコ cz
中国 cn
デンマーク dk
ドイツ de
日本 jp
ノルウェー no
フィンランド fi
フランス fr
ブラジル br
ベルギー be
ポーランド pl
ロシア ru

戻り値:
Returns the language.

setLanguage

public void setLanguage(java.lang.String language)
language string: ja(デフォルト)
languageで書かれた結果になります。
「サポートしている言語」
アメリカ us
アルゼンチン ar
イギリス uk
イタリア it
オランダ nl
オーストラリア au
オーストリア at
カナダ ca
韓国 kr
スイス ch
スウェーデン se
スペイン es
台湾 tw
チェコ cz
中国 cn
デンマーク dk
ドイツ de
日本 jp
ノルウェー no
フィンランド fi
フランス fr
ブラジル br
ベルギー be
ポーランド pl
ロシア ru

パラメータ:
language - language を設定する。

clearLanguage

public void clearLanguage()

getQuery

public java.lang.String getQuery()
必須 (UTF-8エンコードされた)検索クエリーです。
このクエリーはYahoo!検索の全言語をサポートし、
またメタキーワードも含みます。

戻り値:
Returns the query.

setQuery

public void setQuery(java.lang.String query)
必須 (UTF-8エンコードされた)検索クエリーです。
このクエリーはYahoo!検索の全言語をサポートし、
またメタキーワードも含みます。

パラメータ:
query - query を設定する。

clearQuery

public void clearQuery()
key queryを初期に値に戻す。


getResultCount

public java.lang.String getResultCount()
integer: 10(デフォルト), 50(最大)
返却結果の数です。

戻り値:
Returns the resultCount.

setResultCount

public void setResultCount(int resultCount)
integer: 10(デフォルト), 50(最大)
返却結果の数です。

パラメータ:
resultCount - resultCount を設定する。

clearResultCount

public void clearResultCount()
key result を初期値に戻す。


getSimilar

public java.lang.String getSimilar()
similar_ok 値なし(デフォルト), 1
同じコンテンツを別の検索結果とするかどうかを指定します。
1の場合は同じコンテンツを含みます。

戻り値:
Returns the similar.

setSimilar

public void setSimilar(WebQueryConst similar)
similar_ok 値なし(デフォルト), 1
同じコンテンツを別の検索結果とするかどうかを指定します。
1の場合は同じコンテンツを含みます。

パラメータ:
similar - similar を設定する。

clearSimilar

public void clearSimilar()
key similarを初期値に戻す。


getSite

public java.lang.String getSite()
site string: 値なし(デフォルト)
検索するドメイン(例えば www.mokkouyou.yahoo.co.jp)を制限します。
30ドメインまで指定することができます (site=www.mokkouyou.yahoo.co.jp&site=www.asahi.com)。

戻り値:
Returns the site.

setSite

public void setSite(java.lang.String site)
site string: 値なし(デフォルト)
検索するドメイン(例えば www.mokkouyou.yahoo.co.jp)を制限します。
30ドメインまで指定することができます (site=www.mokkouyou.yahoo.co.jp&site=www.asahi.com)。

パラメータ:
site - site を設定する。

clearSite

public void clearSite()
key siteを初期値に戻す。


getStart

public java.lang.String getStart()
start integer: 1(デフォルト)
返却結果の先頭位置(1 - based)です。
最終位置(start + results - 1)は、1000を超えられません。

戻り値:
Returns the start.

setStart

public void setStart(int start)
start integer: 1(デフォルト)
返却結果の先頭位置(1 - based)です。
最終位置(start + results - 1)は、1000を超えられません。

パラメータ:
start - start を設定する。

clearStart

public void clearStart()
key startを初期値に戻す。


getType

public java.lang.String getType()
all(デフォルト), any, phrase
指定検索の種類:
allは全クエリー文字を含む検索結果を返します。
anyはクエリー文字のうちいずれかを含む検索結果を返します。
phraseはクエリー文字を文章として含む検索結果を返します。

戻り値:
Returns the type.

setType

public void setType(WebQueryConst type)
all(デフォルト), any, phrase
指定検索の種類:
allは全クエリー文字を含む検索結果を返します。
anyはクエリー文字のうちいずれかを含む検索結果を返します。
phraseはクエリー文字を文章として含む検索結果を返します。

パラメータ:
type - type を設定する。

clearType

public void clearType()
key typeを初期値に戻す。


createQueryString

public java.lang.String createQueryString()
                                   throws java.lang.Exception
設定した値を元にクエリを構築する。

戻り値:
クエリつきURL
例外:
java.lang.Exception - クエリが設定されていない場合