update Java client sources with Japanese

java_client/src/com/toshiba/mwcloud/gs/Aggregation.java

@@ -16,6 +16,24 @@
 package com.toshiba.mwcloud.gs;
 
 /**
+ * <div lang="ja">
+ * ロウ集合またはその特定のカラムに対する、集計演算の方法を示します。
+ *
+ * <p>現バージョンでは、{@link TimeSeries}に対してのみ使用できます。</p>
+ *
+ * <p>重み付きの演算の場合、キーの値に基づき重み付け値を決定します。
+ * {@link TimeSeries}に対する重み付きの演算の場合、前後それぞれの
+ * 時刻のロウとの中間時刻間の期間を特定の単位で換算したものを、
+ * 重み付け値として使用します。
+ * ただし、前後いずれかの時刻のロウのみが存在しない場合は、存在しないロウの
+ * 代わりに重み付け対象のロウを用いて求めた重み付け値を使用します。
+ * 前後いずれの時刻のロウも存在しない場合は、重み付け値として{@code 1}
+ * (単位は前後いずれかのロウが存在する場合と同一)を使用します。</p>
+ *
+ * <p>演算の内部処理にてオーバーフローが発生した場合、浮動小数点数型では
+ * 負または正の無限大、整数型では未定義の値が求まります。また、浮動小数点数型にて
+ * 演算対象に非数(NaN)が含まれていた場合、非数が求まります。</p>
+ * </div><div lang="en">
  * Represents the methods of aggregation operation on a set of Rows or their specific Columns.
  *
  * <p>Available only to {@link TimeSeries} in the current version. </p>
@@ -31,72 +49,141 @@
  * for floating point operation, and the value "undefined" is returned
  * for integer operation. And if NaN is given as an operand for floating-point operation,
  * NaN is returned. </p>
+ * </div>
  */
 public enum Aggregation {
 
 	/**
+	 * <div lang="ja">
+	 * 最小値を求める演算です。
+	 *
+	 * <p>大小比較できる型、すなわち数値型や時刻型のカラムに対してのみ使用できます。
+	 * 演算結果の型は、対象のカラムと同一の型となります。
+	 * 対象となるロウが1つも存在しない場合、演算結果は設定されません。</p>
+	 * </div><div lang="en">
 	 * An operation to obtain a minimum value.
 	 *
 	 * <p>Available only to Columns of numeric and time types allowing magnitude comparison.
 	 * The type of a returned value is the same as that of a specified Column.
 	 * If no target Row exists, the aggregation result will not be stored
 	 * in a result object. </p>
+	 * </div>
 	 */
 	MINIMUM,
 
 	/**
+	 * <div lang="ja">
+	 * 最大値を求める演算です。
+	 *
+	 * <p>大小比較できる型、すなわち数値型や時刻型のカラムに対してのみ使用できます。
+	 * 演算結果の型は、対象のカラムと同一の型となります。
+	 * 対象となるロウが1つも存在しない場合、演算結果は設定されません。</p>
+	 * </div><div lang="en">
 	 * An operation to obtain a maximum value.
 	 *
 	 * <p>Available only to Columns of numeric and time types allowing magnitude comparison.
 	 * The type of a returned value is the same as that of a specified Column.
 	 * If no target Row exists, the aggregation result will not be stored in a result object.
 	 * </p>
+	 * </div>
 	 */
 	MAXIMUM,
 
 	/**
+	 * <div lang="ja">
+	 * 合計を求める演算です。
+	 *
+	 * <p>数値型のカラムに対してのみ使用できます。
+	 * 演算結果の型は、対象のカラムが整数型の場合LONG、
+	 * 浮動小数点型の場合 DOUBLEとなります。
+	 * 対象となるロウが1つも存在しない場合、演算結果は設定されません。</p>
+	 * </div><div lang="en">
 	 * An operation to obtain a sum total.
 	 *
 	 * <p>Available only to numeric-type Columns. The type of a returned value is LONG
 	 * if a specified Column is of integer type, and DOUBLE if it is of floating-point type.
 	 * If no target Row exists, the aggregation result will not be stored in a result object.</p>
+	 * </div>
 	 */
 	TOTAL,
 
 	/**
+	 * <div lang="ja">
+	 * 平均を求める演算です。
+	 *
+	 * <p>数値型のカラムに対してのみ使用できます。
+	 * 演算結果の型は常にDOUBLEとなります。
+	 * 対象となるロウが1つも存在しない場合、演算結果は設定されません。</p>
+	 * </div><div lang="en">
 	 * An operation to obtain an average.
 	 *
 	 * <p>Available only to numeric-type Columns. The type of a returned value is
 	 * always DOUBLE. If no target Row exists, the aggregation result will
 	 * not be stored in a result object.</p>
+	 * </div>
 	 */
 	AVERAGE,
 
 	/**
+	 * <div lang="ja">
+	 * 分散を求める演算です。
+	 *
+	 * <p>数値型のカラムに対してのみ使用できます。
+	 * 演算結果の型は常にDOUBLEとなります。
+	 * 対象となるロウが1つも存在しない場合、演算結果は設定されません。</p>
+	 * </div><div lang="en">
 	 * An operation to obtain a variance.
 	 *
 	 * <p>Available only to numeric-type Columns. The type of a returned value is always DOUBLE.
 	 * If no target Row exists, the aggregation result will not be stored in a result object. </p>
+	 * </div>
 	 */
 	VARIANCE,
 
 	/**
+	 * <div lang="ja">
+	 * 標準偏差を求める演算です。
+	 *
+	 * <p>数値型のカラムに対してのみ使用できます。
+	 * 演算結果の型は常にDOUBLEとなります。
+	 * 対象となるロウが1つも存在しない場合、演算結果は設定されません。</p>
+	 * </div><div lang="en">
 	 * An operation to obtain a standard deviation.
 	 *
 	 * <p>Available only to numeric-type Columns. The type of a returned value is always DOUBLE.
 	 * If no target Row exists, the aggregation result will not be stored in a result object. </p>
+	 * </div>
 	 */
 	STANDARD_DEVIATION,
 
 	/**
+	 * <div lang="ja">
+	 * 標本数、すなわち対象ロウの個数を求める演算です。
+	 *
+	 * <p>任意のカラムに対して使用できます。
+	 * 演算結果の型は常にLONGとなります。
+	 * 対象となるロウが1つも存在しない場合、演算結果の値は{@code 0}となります。</p>
+	 * </div><div lang="en">
 	 * An operation to obtain the number of samples, i.e., the number of Rows.
 	 *
 	 * <p>Available to any kinds of Columns. The type of a returned value is always LONG.
 	 * If no target Row exists, the aggregation result will not be stored in a result object. </p>
+	 * </div>
 	 */
 	COUNT,
 
 	/**
+	 * <div lang="ja">
+	 * 重み付きで平均を求める演算です。
+	 *
+	 * <p>各標本値と重み付け値との積の合計を、各重み付け値の合計で割ることにより
+	 * 求めます。重み付け値の計算方法は、{@link Aggregation}の説明を
+	 * 参照してください。</p>
+	 *
+	 * <p>この演算は、数値型のカラムに対してのみ使用できます。
+	 * 演算結果の型は常にDOUBLEとなります。
+	 * 対象となるロウが1つも存在しない場合、演算結果は設定されません。</p>
+	 * </div><div lang="en">
 	 * An operation to obtain a weighted average.
 	 *
 	 * <p>The weighted average is calculated by dividing the sum of products of
@@ -106,6 +193,7 @@ public enum Aggregation {
 	 * <p>This operation is only available to numeric-type Columns. The type of
 	 * a returned value is always DOUBLE. If no target Row exists,
 	 * the aggregation result will not be stored in a result object. </p>
+	 * </div>
 	 */
 	WEIGHTED_AVERAGE
 

java_client/src/com/toshiba/mwcloud/gs/AggregationResult.java

@@ -18,6 +18,23 @@
 import java.util.Date;
 
 /**
+ * <div lang="ja">
+ * 集計演算の結果を保持します。
+ *
+ * <p>集計演算に関するクエリの実行もしくは
+ * {@link TimeSeries#aggregate(Date, Date, String, Aggregation)}
+ * により取得できる、集計演算の結果を保持します。
+ * 整数型カラムに対する演算結果を浮動小数点型として、また、有効桁数の
+ * 少ない数値型のカラムに対する演算結果をより桁数の多い数値型として
+ * 受け取ることができます。</p>
+ *
+ * <p>保持する型は、集計演算の種別や集計対象のカラムの型によって決定されます。
+ * 具体的な規則は{@link Aggregation}またはTQLの仕様を参照してください。</p>
+ *
+ * <p>取り出しできる型は、保持されている型によって決まります。
+ * 保持されている型が数値型の場合はDOUBLE型またはLONG型、TIMESTAMP型の
+ * 場合はTIMESTAMP型の値としてのみ取り出しできます。</p>
+ * </div><div lang="en">
  * Stores the result of an aggregation operation.
  *
  * <p>Stores the result returned by an aggregation Query or
@@ -34,38 +51,69 @@
  * <p>The type of obtaining value depends on the stored type.
  * DOUBLE type and LONG type are only available when a result is of numeric type,
  * and TIMESTAMP type when a result is of TIMESTAMP type.</p>
+ * </div>
  */
 public interface AggregationResult {
 
 	/**
+	 * <div lang="ja">
+	 * 数値型の集計値をDOUBLE型({@link Double})として取得します。
+	 *
+	 * <p>数値型以外の値を保持している場合、{@code null}を返します。
+	 * DOUBLE型以外の数値を保持している場合、DOUBLE型に変換したものを返します。</p>
+	 *
+	 * @return DOUBLE型({@link Double})の集計値。結果が数値型以外の場合は
+	 * {@code null}
+	 * </div><div lang="en">
 	 * Obtains the result of aggregating numeric-type values in DOUBLE type ({@link Double}).
 	 *
 	 * <p>It returns {@code null} if a result is not of numeric type. If a result is not of DOUBLE type,
 	 * it returns the value converted to DOUBLE. </p>
 	 *
 	 * @return Result of aggregating DOUBLE type ({@link Double}).
 	 * If the type of result is different, returns {@code null}.
+	 * </div>
 	 */
 	public Double getDouble();
 
 	/**
+	 * <div lang="ja">
+	 * 数値型の集計値をLONG型({@link Long})として取得します。
+	 *
+	 * <p>数値型以外の値を保持している場合、{@code null}を返します。
+	 * LONG型以外の数値を保持している場合、LONG型に変換したものを返します。</p>
+	 *
+	 * @return LONG型({@link Double})の集計値。結果が数値型以外の場合は
+	 * {@code null}
+	 * </div><div lang="en">
 	 * Obtains the result of aggregating numeric-type values in LONG type ({@link Long}).
 	 *
 	 * <p>It returns {@code null} if a result is not of numeric type.
 	 * If a result is not of LONG type, it returns the value converted to LONG.</p>
 	 *
 	 * @return Result of aggregating LONG type ({@link Long}).
 	 * If the type of result is different, returns {@code null}.
+	 * </div>
 	 */
 	public Long getLong();
 
 	/**
+	 * <div lang="ja">
+	 * 時刻型の集計値をTIMESTAMP型({@link Date})で取得します。
+	 *
+	 * <p>TIMESTAMP型以外の値を保持している場合、{@code null}を
+	 * 返します。</p>
+	 *
+	 * @return TIMESTAMP型({@link Date})の集計値。結果がTIMESTAMP型
+	 * 以外の場合は{@code null}
+	 * </div><div lang="en">
 	 * Obtains the result of aggregating time-type values in TIMESTAMP type ({@link Date}).
 	 *
 	 * <p>It returns {@code null} if a result is not of TIMESTAMP type. </p>
 	 *
 	 * @return Result of aggregating TIMESTAMP type ({@link Date}).
 	 * If the type of result is different, returns {@code null}.
+	 * </div>
 	 */
 	public Date getTimestamp();
 

java_client/src/com/toshiba/mwcloud/gs/Collection.java

@@ -17,6 +17,26 @@
 
 
 /**
+ * <div lang="ja">
+ * ロウ集合を汎用的に管理するためのコンテナです。
+ *
+ * <p>ロウキーには次の型が使用できます。</p>
+ * <ul>
+ * <li>文字列型({@link String})</li>
+ * <li>INTEGER型({@link Integer})</li>
+ * <li>LONG型({@link Long})</li>
+ * <li>TIMESTAMP型({@link java.util.Date})</li>
+ * </ul>
+ * <p>ロウキーの設定は必須ではありません。</p>
+ *
+ * <p>ロウ操作について、コンテナ固有の制限は設けられていません。</p>
+ *
+ * <p>{@link #query(String)}もしくは{@link GridStore#multiGet(java.util.Map)}
+ * などより複数のロウの内容を一度に取得する場合、特に指定がなければ、
+ * 返却されるロウの順序は不定となります。</p>
+ *
+ * <p>ロック粒度はロウ単位です。</p>
+ * </div><div lang="en">
  * A general-purpose Container for managing a set of Rows.
  *
  * <p>The following types are available as a Row key.</p>
@@ -35,10 +55,28 @@
  * when order is not specified.</p>
  *
  * <p>The granularity of locking is a Row. </p>
+ * </div>
  */
 public interface Collection<K, R> extends Container<K, R> {
 
 	/**
+	 * <div lang="ja">
+	 * 指定した空間範囲条件に合致するロウ集合を求めるための、クエリを作成します。
+	 *
+	 * <p>{@link Query#fetch(boolean)}を通じてロウ集合を求める際、
+	 * 更新用ロックのオプションを有効にすることもできます。</p>
+	 *
+	 * <p>現バージョンでは、{@link GSException}や、{@code null}を指定できない
+	 * 引数で{@code null}を指定したことによる{@link NullPointerException}は
+	 * 送出されません。カラム名の誤りなどがあった場合、得られたクエリをフェッチする
+	 * 際に例外が送出されます。</p>
+	 *
+	 * @param column 比較対象の空間型カラムの名前。{@code null}は指定できない
+	 * @param geometry 比較対象として与える空間構造。{@code null}は指定できない
+	 * @param geometryOp 比較方法。{@code null}は指定できない
+	 *
+	 * @throws GSException 現バージョンでは送出されない
+	 * </div><div lang="en">
 	 * Creates a query to obtain a set of Rows which are matched to specified
 	 * geometry range conditions.
 	 *
@@ -59,12 +97,37 @@ public interface Collection<K, R> extends Container<K, R> {
 	 * @param geometryOp Comparison method. {@code null} cannot be specified
 	 *
 	 * @throws GSException It will not be thrown in the current version.
+	 * </div>
 	 */
 	public Query<R> query(
 			String column, Geometry geometry, GeometryOperator geometryOp)
 			throws GSException;
 
 	/**
+	 * <div lang="ja">
+	 * 除外範囲付きの空間範囲条件に合致するロウ集合を求めるための、
+	 * クエリを作成します。
+	 *
+	 * <p>{@code geometryIntersection}と交差し、かつ、{@code geometryDisjoint}と
+	 * 交差しないカラム値を持つロウ集合を取得します。交差判定の条件は、
+	 * {@link GeometryOperator#INTERSECT}と同一です。</p>
+	 *
+	 * <p>{@link Query#fetch(boolean)}を通じてロウ集合を求める際、
+	 * 更新用ロックのオプションを有効にすることもできます。</p>
+	 *
+	 * <p>現バージョンでは、{@link GSException}や、{@code null}を指定できない
+	 * 引数で{@code null}を指定したことによる{@link NullPointerException}は
+	 * 送出されません。カラム名の誤りなどがあった場合、得られたクエリをフェッチする
+	 * 際に例外が送出されます。</p>
+	 *
+	 * @param column 比較対象の空間型カラムの名前。{@code null}は指定できない
+	 * @param geometryIntersection カラム上の値と交差する範囲を示す空間構造。
+	 * {@code null}は指定できない
+	 * @param geometryDisjoint カラム上の値と交差しない範囲を示す空間構造。
+	 * {@code null}は指定できない
+	 *
+	 * @throws GSException 現バージョンでは送出されない
+	 * </div><div lang="en">
 	 * Creates a query to obtain a set of Rows which are matched to specified
 	 * geometry range conditions with exclusion range.
 	 *
@@ -88,6 +151,7 @@ public Query<R> query(
 	 * not intersect with the values on the column. {@code null} cannot be specified
 	 *
 	 * @throws GSException It will not be thrown in the current version.
+	 * </div>
 	 */
 	public Query<R> query(
 			String column, Geometry geometryIntersection, Geometry geometryDisjoint)