KeyFactory(Google App Engine API for Java)

com.google.appengine.api.datastore

クラス KeyFactory

  • java.lang.Object
    • com.google.appengine.api.datastore.KeyFactory


  • public class KeyFactory
    extends java.lang.Object
    このクラスを使用すると、ルート エンティティ グループ(親なし)内に、指定された親の子として Key オブジェクトを直接作成できます。名前付きエンティティをデータストアに格納して、新しいキーを割り当てることによって、間接的にキーを作成することもできます。詳細については、Entity.Entity(String, String) をご覧ください。

    このクラスには、Key オブジェクトを文字列にエンコードするメソッドと文字列からデコードするメソッドもあります。クライアントでは、HTML または URL で使用するときに引用符で囲む必要のないウェブセーフ文字列であること以外に、エンコード形式を意識する必要はありません。

    関連情報:
    Entity
    • ネストクラスの概要

      ネストクラス 
      修飾子と型 クラスと説明
      static class  KeyFactory.Builder
      祖先を持つ Keys の構築を支援するヘルパークラス。
    • メソッドの概要

      すべてのメソッド 静的メソッド 具象メソッド 
      修飾子と型 メソッドと説明
      static Key createKey(Key parent, java.lang.String kind, long id)
      その種類と ID から、指定された親を持つ新しい Key を作成します。
      static Key createKey(Key parent, java.lang.String kind, java.lang.String name)
      その種類と名前から、指定された親を持つ新しい Key を作成します。
      static Key createKey(java.lang.String kind, long id)
      その種類と ID から、親を持たない新しい Key を作成します。
      static Key createKey(java.lang.String kind, java.lang.String name)
      その種類と名前から、親を持たない新しい Key を作成します。
      static java.lang.String createKeyString(Key parent, java.lang.String kind, long id)
      createKey(Key, String, long) の結果に対する keyToString(Key) の呼び出しの省略形。
      static java.lang.String createKeyString(Key parent, java.lang.String kind, java.lang.String name)
      createKey(Key, String, String) の結果に対する keyToString(Key) の呼び出しの省略形。
      static java.lang.String createKeyString(java.lang.String kind, long id)
      createKey(String, long) の結果に対する keyToString(Key) の呼び出しの省略形。
      static java.lang.String createKeyString(java.lang.String kind, java.lang.String name)
      createKey(String, String) の結果に対する keyToString(Key) の呼び出しの省略形。
      static java.lang.String keyToString(Key key)
      Key をウェブセーフ文字列に変換します。
      static Key stringToKey(java.lang.String encoded)
      KeyString 表現を Key インスタンスに変換します。
      • java.lang.Object から継承されたメソッド

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • メソッドの詳細

      • createKey

        public static Key createKey(java.lang.String kind,
                                    long id)
        その種類と ID から、親を持たない新しい Key を作成します。
        パラメータ:
        kind - 作成するキーの種類。
        id - この種類のすべてのルート エンティティで一意である kind のキーの数値識別子。ゼロにすることはできません。
      • createKey

        public static Key createKey(Key parent,
                                    java.lang.String kind,
                                    long id)
        その種類と ID から、指定された親を持つ新しい Key を作成します。
        パラメータ:
        parent - 作成するキーの親。null にすることができます。
        kind - 作成するキーの種類。
        id - 同じ親を持つこの種類のすべてのエンティティで一意である kind のキーの数値識別子。ゼロにすることはできません。
      • createKey

        public static Key createKey(java.lang.String kind,
                                    java.lang.String name)
        その種類と名前から、親を持たない新しい Key を作成します。
        パラメータ:
        kind - 作成するキーの種類。
        name - kind のキーの名前。この kind のすべてのルート エンティティで一意である任意の文字列です。
      • createKey

        public static Key createKey(Key parent,
                                    java.lang.String kind,
                                    java.lang.String name)
        その種類と名前から、指定された親を持つ新しい Key を作成します。
        パラメータ:
        parent - 作成するキーの親。null にすることができます。
        kind - 作成するキーの種類。
        name - kind のキーの名前。同じ親を持つこの kind のすべてのエンティティで一意である任意の文字列です。
      • createKeyString

        public static java.lang.String createKeyString(java.lang.String kind,
                                                       long id)
        createKey(String, long) の結果に対する keyToString(Key) の呼び出しの省略形。
        パラメータ:
        kind - 作成するキーの種類。
        id - この種類のすべてのルート エンティティで一意である kind のキーの数値識別子。ゼロにすることはできません。
        戻り値:
        作成された Key のウェブセーフ String 表現。
      • createKeyString

        public static java.lang.String createKeyString(Key parent,
                                                       java.lang.String kind,
                                                       long id)
        createKey(Key, String, long) の結果に対する keyToString(Key) の呼び出しの省略形。
        パラメータ:
        parent - 作成するキーの親。null にすることができます。
        kind - 作成するキーの種類。
        id - 同じ親を持つこの種類のエンティティで一意である kind のキーの数値識別子。ゼロにすることはできません。
        戻り値:
        作成された Key のウェブセーフ String 表現。
      • createKeyString

        public static java.lang.String createKeyString(java.lang.String kind,
                                                       java.lang.String name)
        createKey(String, String) の結果に対する keyToString(Key) の呼び出しの省略形。
        パラメータ:
        kind - 作成するキーの種類。
        name - kind のキーの名前。この kind のルート エンティティで一意である任意の文字列です。
        戻り値:
        作成された Key のウェブセーフ String 表現。
      • createKeyString

        public static java.lang.String createKeyString(Key parent,
                                                       java.lang.String kind,
                                                       java.lang.String name)
        createKey(Key, String, String) の結果に対する keyToString(Key) の呼び出しの省略形。
        パラメータ:
        parent - 作成するキーの親。null にすることができます。
        kind - 作成するキーの種類。
        name - kind のキーの名前。同じ親を持つこの kind のエンティティで一意である任意の文字列です。
        戻り値:
        作成された Key のウェブセーフ String 表現。
      • keyToString

        public static java.lang.String keyToString(Key key)
        Key をウェブセーフ文字列に変換します。たとえば、この文字列は、HTML ドキュメントに埋め込まれた URL パラメータとして安全に使用できます。 key.equals(KeyFactory.stringToKey(KeyFactory.keyToString(key)) true に評価する必要があるので注意してください。
        パラメータ:
        key - String に変換する Key
        戻り値:
        指定された String のウェブセーフ String 表現。
        スロー:
        java.lang.IllegalArgumentException - 指定された Key が不完全な場合。
      • stringToKey

        public static Key stringToKey(java.lang.String encoded)
        KeyString 表現を Key インスタンスに変換します。 str.equals(KeyFactory.keyToString(KeyFactory.stringToKey(str)) true に評価する必要があります(keyToString(com.google.appengine.api.datastore.Key) から返されたすべての文字列が対象です)。
        パラメータ:
        encoded - KeyString 表現。
        戻り値:
        指定された String が表す Key
        スロー:
        java.lang.IllegalArgumentException - 文字列を解析できない場合。
このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...

Java の App Engine スタンダード環境