Atom ライブラリーは、大まかにユーティリティー関数、 Atom データ・モデル、および AtomIO オブジェクトの 3 つのカテゴリーに分かれています。
関数の要約 | |
---|---|
ストリング | createDate(DOMNode node) DOM のノード・テキスト・コンテンツから日付を作成します |
ストリング | escapeHtml(String str) HTML ストリング内の XML 特殊文字をエスケープします |
ストリング | unEscapeHtml(String str) HTML ストリング内の XML 特殊文字をアンエスケープします |
日付 | getIso8601Date(String iso8601String) ISO-8610 日付ストリングを日付オブジェクトに変換します |
ストリング | dateToIso8601String(Date date, String offset) 日付オブジェクトを ISO-8610 ストリングに変換します |
ストリング | getNodename(DOMNode node) ノード名を取得します |
関数の詳細 |
---|
Atom エレメントについては、 ここで Atom 仕様を参照してください。
コンポーネントの概要 | |
---|---|
ibm_atom.io.atom.AtomItem | 汎用 Atom エレメント。 エントリーとフィードの基本クラスです。 |
ibm_atom.io.atom.Category | Atom カテゴリー・エレメント |
ibm_atom.io.atom.Content | Atom コンテンツ・エレメント。 Atom 仕様に従って、複数のタイプ (テキスト、html など) を処理します。 コンテンツ、要約、およびタイトルに使用します。 |
ibm_atom.io.atom.Link | Atom リンク・エレメント。 複数のリンク・タイプ (edit、alt など) を処理します。 |
ibm_atom.io.atom.Person | Atom 個人エレメント。 作成者と投稿者を示すために使用します。 |
ibm_atom.io.atom.Generator | Atom ジェネレーター・エレメント |
ibm_atom.io.atom.Entry | Atom エントリー・エレメント。 作成者、投稿者、タイトル、コンテンツなどの保管を含む、Atom エントリーを示します。 |
ibm_atom.io.atom.Feed | Atom フィード・エレメント。 フィード・エレメント (タイトルと作成者など) を含む、Atom フィードを示します。 また、エントリー・リストも示します。 |
ibm_atom.io.atom.Service | Atom サービス・エレメント |
ibm_atom.io.atom.Workspace | Atom ワークスペース・エレメント |
ibm_atom.io.atom.Collection | Atom コレクション・エレメント |
コンポーネントの詳細 |
---|
通常、単独では使用されません。 AtomItem クラスは、Atom フィード・オブジェクトとエントリー・オブジェクトの基本クラスです。 これは、Atom フィード・オブジェクトとエントリー・オブジェクトが一部の共通コンポーネント (タイトル、 サブタイトル、アイコン、作成者、投稿者、およびリンクの配列) を共用するためです。
オブジェクトの変数 | ||
---|---|---|
ストリング | ATOM_URI | Atom ネーム・スペースの URI |
配列 | links | この Atom 項目に関連したリンクの複数の ibm_atom.io.atom.Link オブジェクトが入っています |
配列 | authors | 作成者の ibm_atom.io.atom.Person オブジェクトが入っています |
配列 | categories | この Atom 項目に関連した ibm_atom.io.atom.Category オブジェクトが入っています |
配列 | contributors | 投稿者の ibm_atom.io.atom.Person オブジェクトが入っています |
ストリング | icon | この項目のアイコンの URL |
ストリング | id | この項目の ID |
ストリング | logo | この項目のロゴの URL |
ストリング | rights | この Atom 項目の関連した権限 |
ibm_atom.io.atom.Content | title | この項目のタイトル |
ibm_atom.io.atom.Content | subtitle | この項目のサブタイトル |
日付 | updated | この項目が更新された日付 |
ibm_atom.io.atom.Content | コンテンツ | この項目のコンテンツ |
配列 | entries | この項目の ibm_atom.io.atom.Entry オブジェクトの配列 |
オブジェクトの関数 | |
---|---|
ブール | accept(String tag) この項目が所定のタグ名を受け入れるかどうかを戻します。 子クラスによってオーバーライドされます。 |
void | _postBuild() 関数は、buildFromDom の完了後に実行されました。 ビルドの完了後に機能を追加する必要がある場合、 子オブジェクトはこの関数をオーバーライドできます。 |
void | buildFromDom(DOMNode node) 所定の DOMNode からこの AtomItem をビルドします。 |
void | addAuthor(String name, String email, String uri) この項目に、所定の情報を持つ作成者を追加します |
void | addContributor(String name, String email, String uri) この項目に、所定の情報を持つ投稿者を追加します |
void | addCategory(String name, String term, String label) この項目に、所定の情報を持つカテゴリーを追加します |
void | addLink(String href, String rel, String hrefLang, String title, String type) この項目に、所定の属性を持つリンクを追加します。 |
数値 | removeLink(String href, String rel) この項目から所定のリンクを除去し、除去されたリンクの数を戻します |
数値 | removeBasicLinks() この項目からすべての基本リンク (rel 属性を持たないリンク) を除去し、 除去されたリンクの数を戻します |
配列 | getCategories(String scheme) この項目の所定のスキームに一致するすべてのカテゴリーを取得し、それらを配列で戻します。 |
数値 | removeCategories(String scheme, String term) 所定のスキームに一致するすべてのカテゴリーを除去し、除去されたカテゴリーの数を戻します。 |
void | setTitle(String str, String type) この項目のタイトルを、所定の type の所定の str に設定します。 |
void | addExtension(String name_space, String name, Array attributes, String content, String shortNS) 拡張ネーム・スペースを追加して項目内に入れます。 |
配列 | getExtensions(String name_space, String name) 所定の name_space と name に一致するすべての拡張を取得し、 これらの拡張を配列で戻します。 name_space は、完全なネーム・スペース (like 'http://www.w3.org/2005/Atom') でも、 所定のショート・ネーム (「atom」など) でもかまいません。 |
void | removeExtensions(String name_space, String name) 所定の name_space と name に一致するすべての拡張を除去します |
void | destroy() この項目に関連したすべての変数を削除します |
このオブジェクトは、Atom 仕様のカテゴリー・エレメントを示します。 エントリーとフィードには、それぞれエントリーまたはフィードに関する情報を伝達するカテゴリー・エレメントが含まれることがあります。
オブジェクトの変数 | ||
---|---|---|
ストリング | scheme | このカテゴリーのスキーム |
ストリング | term | このカテゴリーの期間 |
ストリング | label | このカテゴリーのラベル |
オブジェクトの関数 | |
---|---|
ブール | accept(String tag) カテゴリーは子エレメントを持たないので、常に false を戻します。 |
void | _postBuild() 関数は、buildFromDom の完了後に実行されました。 ビルドの完了後に機能を追加する必要がある場合、 子オブジェクトはこの関数をオーバーライドできます。 |
ストリング | toString() このカテゴリーを表すストリングを XML で戻します。 |
void | buildFromDom(DOMNode node) 所定の XML ノードからこのカテゴリーを作成します |
このオブジェクトは、汎用コンテンツ・オブジェクトをモデル化します。 これは、Atom 仕様では、タイトル、サブタイトル、コンテンツ、および要約として使用されます。 コンテンツ・オブジェクトには、その値のほかにさまざまなタイプがあります。
オブジェクトの変数 | ||
---|---|---|
ストリング | tagName | このエレメントの名前 (コンテンツ、要約など) |
ストリング | value | このエレメントの値 |
ストリング | src | このエレメントの値が含まれている URL |
ストリング | type | このエレメントに保管されているコンテンツのタイプ。 許容値は、以下にリストされるとおりです。 |
ストリング | xmlLang | このコンテンツの言語。 この言語は、このエレメントがストリングになっている場合は出力に含まれます。 |
ストリング | HTML | HTML タイプを表すストリング |
ストリング | TEXT | テキスト・タイプを表すストリング |
ストリング | XHTML | XHTML タイプを表すストリング |
ストリング | XML | XML タイプを表すストリング |
オブジェクトの関数 | |
---|---|
void | _postBuild() 関数は、buildFromDom の完了後に実行されました。 ビルドの完了後に機能を追加する必要がある場合、 子オブジェクトはこの関数をオーバーライドできます。 |
void | buildFromDom(DOMNode node) 所定の DOMNode からこのコンテンツ・オブジェクトをビルドします。 |
ストリング | toString() このカテゴリーを表すストリングを XML として戻します。 |
このオブジェクトは、Atom リンク・エレメントを表します。
オブジェクトの変数 | ||
---|---|---|
ストリング | href | このリンクの URL |
ストリング | hrefLang | hrefLang 属性 |
ストリング | rel | このリンクの親項目に対する関係を記述する rel 属性 |
ストリング | title | このリンクのタイトル |
ストリング | type | リンクのタイプ |
オブジェクトの関数 | |
---|---|
void | _postBuild() 関数は、buildFromDom の完了後に実行されました。 ビルドの完了後に機能を追加する必要がある場合、 子オブジェクトはこの関数をオーバーライドできます。 |
void | buildFromDom(DOMNode node) 所定の DOMNode からこのリンク・オブジェクトをビルドします |
ストリング | toString() このカテゴリーを表すストリングを XML で戻します。 |
このオブジェクトは、個人オブジェクトを表します。 これは、Atom 仕様では作成者と投稿者のタイプに使用されます。 個人オブジェクトには、名前、E メール・アドレス、URI、またはその両方があります。
オブジェクトの変数 | ||
---|---|---|
ストリング | personType | このオブジェクトが表す個人のタイプ (通常、作成者または投稿者)。 |
ストリング | name | この個人オブジェクトの名前 |
ストリング | この個人のこの E メール・アドレス | |
ストリング | uri | この個人のこの URI |
オブジェクトの関数 | |
---|---|
void | _postBuild() 関数は、buildFromDom の完了後に実行されました。 ビルドの完了後に機能を追加する必要がある場合、 子オブジェクトはこの関数をオーバーライドできます。 |
void | buildFromDom(DOMNode node) 所定の DOMNode からこの個人オブジェクトをビルドします。 |
ストリング | toString() このカテゴリーを表すストリングを XML で戻します。 |
ブール | accept(String tag) この項目が所定のタグ名を受け入れるかどうかを戻します。 子クラスによってオーバーライドされます。 |
この Atom エレメントは、この Atom フィードを生成したパッケージに関する情報を伝達します。 ジェネレーターには、人間が読み取れる名前のほかに URI とバージョン番号があります。
オブジェクトの変数 | ||
---|---|---|
ストリング | uri | このジェネレーターの URI |
ストリング | version | このジェネレーターのバージョン番号 |
ストリング | value | 人間が読み取れる、このジェネレーターの名前 |
オブジェクトの関数 | |
---|---|
void | _postBuild() 関数は、buildFromDom の完了後に実行されました。 ビルドの完了後に機能を追加する必要がある場合、 子オブジェクトはこの関数をオーバーライドできます。 |
void | buildFromDom(DOMNode node) 所定の DOMNode からこのジェネレーター・オブジェクトをビルドします。 |
ストリング | toString() このカテゴリーを表すストリングを XML として戻します。 |
このオブジェクトは Atom エントリー・エレメントを表し、ibm_atom.io.atom.AtomItem を拡張します。 該当する継承された変数と関数は、ここにあります。
オブジェクトの変数 | ||
---|---|---|
ストリング | feedUrl | この項目を所有する、Atom フィードの URL |
オブジェクトの関数 | |
---|---|
ストリング | toString() このカテゴリーを表すストリングを XML で戻します。 |
ブール | accept(String tag) この項目が所定のタグ名を受け入れるかどうかを戻します。 子クラスによってオーバーライドされます。 |
ストリング | getEditHref() Atom Publishing Protocol を経由した更新済みエントリー情報の送信先 URL をディスカバーします |
このオブジェクトは Atom フィード・エレメントを表し、ibm_atom.io.atom.AtomItem を拡張します。 該当する継承された変数と関数は、ここにあります。
オブジェクトの関数 | |
---|---|
ストリング | toString() このカテゴリーを表すストリングを XML で戻します。 |
ブール | accept(String tag) この項目が所定のタグ名を受け入れるかどうかを戻します。 子クラスによってオーバーライドされます。 |
void | addNamespace(String fullName, String shortName) 所定のネーム・スペースをこのフィードに追加します |
void | addEntry(ibm_atom.io.atom.Entry Entry) 所定のエントリーを、Atom フィードのこのオブジェクト表記内に追加します。 この関数は、サーバーにはデータを送信しません。 |
ibm_atom.io.atom.Entry | getFirstEntry() この Atom フィードの最初のエントリーを検索します |
ibm_atom.io.atom.Entry | getEntry(String entryId) 所定の ID ストリングで識別されるエントリーを検索します |
数値 | removeEntry(ibm_atom.io.atom.Entry entry) フィードから所定の項目を除去し、除去されたエントリーの数を戻します |
void | setEntries(Array arrayOfEntry) 所定の配列に含まれるエントリーをこの Atom フィード内に追加します |
ibm_atom.io.atom.Entry | createEntry() 新規の空のエントリー・オブジェクトを作成し、その feedUrl 変数を設定して、 エントリー・オブジェクトを戻します。 |
ストリング | getSelfHref() この Atom フィードの URL を取得するか、 フィードに該当するリンク・オブジェクトが含まれていない場合はヌル値を戻します |
Atom Publishing Protocol を実装するサーバーが提供するサービスを記述する Atom サービス文書。 このオブジェクトは、文書のタイプを示します。
オブジェクトの変数 | ||
---|---|---|
ストリング | href | サービス文書の URL |
オブジェクトの関数 | |
---|---|
void | buildFromDom(DOMNode node) 所定の DOMNode からこのサービス文書をビルドします |
配列 | getCollection(String url) 所定の URL で識別されたすべてのコレクションの配列を検索します |
Atom Publishing Protocol 仕様で定義されるように、Atom ワークスペース・エレメントは、Atom サービス文書の一部であり、 サービス文書内の組織向けです。
オブジェクトの変数 | ||
---|---|---|
ストリング | title | このワークスペースのタイトル |
配列 | collections | このワークスペースに入っているコレクション |
オブジェクトの関数 | |
---|---|
void | buildFromDom(DOMNode node) 所定の DOMNode からこのワークスペースをビルドします |
Atom コレクションは、所定の URL からアクセス可能な、タイトルで識別されるリソースのセットを記述します。
オブジェクトの変数 | ||
---|---|---|
ストリング | href | このコレクションの URL |
ストリング | title | このコレクションのタイトル |
配列 | attributes | このコレクションの属性 |
配列 | features | このコレクションのフィーチャー |
配列 | children | このコレクションの子 (例えば、<accept> または <category> エレメント) |
ストリング | memberType | このコレクションのメンバー・タイプ |
ストリング | id | このコレクションの ID ストリング |
オブジェクトの関数 | |
---|---|
void | buildFromDom(DOMNode node) 所定の DOMNode からこのコレクション・オブジェクトをビルドします |
AtomIO オブジェクトは、開発者が簡単に Atom フィードや Atom Publishing Protocol (APP) サーバー実装とのインターフェースを開始できる、 使いやすいインターフェース提供するためのものです。 このオブジェクトは、フィード・オブジェクトや呼び出し間の内部変数の保守は行いません。 開発者がフィード (前述のフィードを参照) のローカル表記とサーバー・コピーとの同期を維持する場合は、 それは開発者の責任で行います。
オブジェクトの変数 | ||
---|---|---|
ブール | sync | この AtomIO オブジェクトからの要求を強制的に同期させるかどうか |
ブール | useCache | (XHR 要求内の) キャッシングをオフにするかどうか |
ブール | alertsEnabled | 入出力エラー時にアラート・ボックスを表示するか、あるいはサイレントにして表示しないようにするか |
オブジェクトの関数 | |
---|---|
void | getFeed(String url, Function callback, Function errorCallback, Object scope) 所定の URL から特定の Atom フィードを検索します |
void | getService(String url, Function callback, Function errorCallback, Object scope) 所定の URL からサービス文書またはイントロスペクション文書を検索します |
void | getEntry(String url, Function callback, Function errorCallback, Object scope) 所定の URL から特定の Atom エントリー文書を検索します |
void | updateEntry(ibm_atom.io.atom.Entry entry, Function callback, Function errorCallback, Boolean retrieveUpdated, Boolean xmethod, Object scope) 所定のエントリーを使用して、リモート・エントリーを更新し、所定のパラメーターに基づいて要求を調整します |
void | addEntry(ibm_atom.io.atom.Entry entry, String url, Function callback, Function errorCallback, Boolean retrieveUpdated, Object scope) 所定のパラメーターに基づいて、所定のコレクション URL に新規エントリーを追加します |
void | deleteEntry(ibm_atom.io.atom.Entry entry, Function callback, Function errorCallback, Boolean xmethod, Object scope) 特定の Atom エントリーをそのコレクションから削除します |
関数の詳細 |
---|