Key(Google App Engine API for Java)

com.google.appengine.api.datastore

クラス Key

  • java.lang.Object
    • com.google.appengine.api.datastore.Key
  • すべての実装インターフェース:
    java.io.Serializable、java.lang.Comparable<Key>


    public final class Key
    extends java.lang.Object
    implements java.io.Serializable, java.lang.Comparable<Key>
    データストア エンティティの主キー。

    データストア GUID。Key インスタンスは、すべてのアプリについてエンティティを一意に識別し、DatastoreService.get(Key) によりデータストアからエンティティを取得するために必要なすべての情報を含みます。

    Key オブジェクトは、KeyFactory.createKey(java.lang.String, long) または getChild(java.lang.String, long) を使用して直接作成できます。

    新しい Entity の作成時に自動的に作成される Key を取得したり、Key オブジェクトをシリアル化したり、KeyFactory を使用してこれらのオブジェクトをウェブセーフの文字列値に変換したり、ウェブセーフの文字列値から変換したりすることもできます。

    関連情報:
    KeyFactoryシリアル化された形式
    • メソッドの概要

      すべてのメソッド インスタンス メソッド 具象メソッド 
      修飾子と型 メソッドと説明
      int compareTo(Key other)
      2 つの Key オブジェクトを比較します。
      boolean equals(java.lang.Object object)
      ID、種類、親、appIdNamespace を比較して、2 つの Key オブジェクトを比較します。
      java.lang.String getAppId()
      この Key の appId を返します。
      Key getChild(java.lang.String kind, long id)
      this を親として持ち、指定された数値識別子を持つ新しいキーを作成します。
      Key getChild(java.lang.String kind, java.lang.String name)
      this を親として持ち、指定された名前を持つ新しいキーを作成します。
      long getId()
      この Key の数値識別子を返します。
      java.lang.String getKind()
      この Key により表される Entity の種類を返します。
      java.lang.String getName()
      この Key の名前を返します。
      java.lang.String getNamespace()
      この Key の名前空間を返します。
      Key getParent()
      この Key が親を持つ場合、その親を表す Key を返します。
      int hashCode() 
      boolean isComplete()
      このキーに名前が指定されているか、識別子が割り当てられている場合に true を返します。
      java.lang.String toString() 
      • クラス java.lang.Object から継承されたメソッド

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

      • getKind

        public java.lang.String getKind()
        この Key により表される Entity の種類を返します。
      • getParent

        public Key getParent()
        この Key が親を持つ場合、その親を表す Key を返します。そうでない場合は、null を返します。
      • hashCode

        public int hashCode()
        オーバーライド:
        hashCode - クラス java.lang.Object
      • toString

        public java.lang.String toString()
        オーバーライド:
        toString - クラス java.lang.Object
      • 等しい

        public boolean equals(java.lang.Object object)
        ID、種類、親、appIdNamespace を比較して、2 つの Key オブジェクトを比較します。両方のキーに ID ではなく名前が割り当てられている場合は、ID の代わりに名前が比較されます。両方のキーが ID も名前も持たない場合、これらのキーは同じオブジェクトを参照している場合にのみ等しくなります。
        オーバーライド:
        equals - クラス java.lang.Object
      • getAppId

        public java.lang.String getAppId()
        この Key の appId を返します。
      • getNamespace

        public java.lang.String getNamespace()
        この Key の名前空間を返します。
      • getId

        public long getId()
        この Key の数値識別子を返します。
      • getName

        public java.lang.String getName()
        この Key の名前を返します。
      • getChild

        public Key getChild(java.lang.String kind,
                            long id)
        this を親として持ち、指定された数値識別子を持つ新しいキーを作成します。親キーは完全である必要があります。
        パラメータ:
        kind - 作成する子キーの種類
        id - この親に固有の、種類が kind のキーの数値識別子
      • getChild

        public Key getChild(java.lang.String kind,
                            java.lang.String name)
        this を親として持ち、指定された名前を持つ新しいキーを作成します。親キーは完全である必要があります。
        パラメータ:
        kind - 作成する子キーの種類
        name - この親に固有の任意の文字列として指定される、種類が kind のキーの名前
      • isComplete

        public boolean isComplete()
        このキーに名前が指定されているか、識別子が割り当てられている場合に true を返します。
      • compareTo

        public int compareTo(Key other)
        2 つの Key オブジェクトを比較します。アルゴリズムは次のように実行されます。各 Key をイテレータに変換します。ここで、返される最初の要素は最上位の祖先で、次の要素は前の要素の子になり、以降も同様に続きます。最後の要素は、最初に使用した Key になります。2 つのイテレータ(1 つは「this」、もう 1 つは比較対象の Key のイテレータ)を作成したら、それらを同時に実行し、各イテレータの次の要素を比較します。これら 2 つの要素の比較によりゼロ以外の結果が得られた時点で、その結果を比較全体の結果として返します。「this」から作成されたイテレータが、もう一方の Key から作成されたイテレータが終了するより先に終了した場合は、「より小さい」を返します。次に例を示します。

        app1.type1.4.app1.type2.9 < app1.type1.4.app1.type2.9.app1.type3.2

        もう一方の Key から作成されたイテレータが、「this」から作成されたイテレータが終了するより先に終了した場合は、「より大きい」を返します。次に例を示します。

        app1.type1.4.app1.type2.9.app1.type3.2 > app1.type1.4.app1.type2.9

        個別の Key Keys 間の関係は、まずアプリを比較し、次に種類を比較し、次に ID を比較することで調べられます。両方のキーに ID ではなく名前が割り当てられている場合は、ID の代わりに名前を比較します。両方のキーが ID も名前も持たない場合は、任意だが、一貫性のある結果を返します。他のすべてのコンポーネントが等しいと仮定すると、すべての ID はすべての名前より小さくなります。

        指定元:
        compareTo - インターフェース java.lang.Comparable<Key>
このページは役立ちましたか?評価をお願いいたします。

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

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