Skip to content

Commit

Permalink
Update javadoc in Table definitions (remove type naming)
Browse files Browse the repository at this point in the history
  • Loading branch information
mziccard committed Feb 9, 2016
1 parent f06c11a commit 3502610
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 22 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@
import java.util.Objects;

/**
* Google BigQuery external table type. BigQuery's external tables are tables whose data reside
* outside of BigQuery but can be queried as normal BigQuery tables. External tables are
* Google BigQuery external table definition. BigQuery's external tables are tables whose data
* reside outside of BigQuery but can be queried as normal BigQuery tables. External tables are
* experimental and might be subject to change or removed.
*
* @see <a href="https://cloud.google.com/bigquery/federated-data-sources">Federated Data Sources
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,11 @@
import java.util.Objects;

/**
* A Google BigQuery default table type. This type is used for standard, two-dimensional tables with
* individual records organized in rows, and a data type assigned to each column (also called a
* field). Individual fields within a record may contain nested and repeated children fields. Every
* table is described by a schema that describes field names, types, and other information.
* A Google BigQuery default table definition. This definition is used for standard, two-dimensional
* tables with individual records organized in rows, and a data type assigned to each column (also
* called a field). Individual fields within a record may contain nested and repeated children
* fields. Every table is described by a schema that describes field names, types, and other
* information.
*
* @see <a href="https://cloud.google.com/bigquery/docs/tables">Managing Tables</a>
*/
Expand Down Expand Up @@ -218,14 +219,14 @@ public StreamingBuffer streamingBuffer() {
}

/**
* Returns a builder for a BigQuery default table type.
* Returns a builder for a BigQuery standard table definition.
*/
public static Builder builder() {
return new Builder();
}

/**
* Creates a BigQuery default table type given its schema.
* Creates a BigQuery standard table definition given its schema.
*
* @param schema the schema of the table
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
import java.util.Objects;

/**
* Base class for a Google BigQuery table type.
* Base class for a Google BigQuery table definition.
*/
public abstract class TableDefinition implements Serializable {

Expand Down Expand Up @@ -63,10 +63,10 @@ public enum Type {
}

/**
* Base builder for table types.
* Base builder for table definitions.
*
* @param <T> the table type class
* @param <B> the table type builder
* @param <T> the table definition class
* @param <B> the table definition builder
*/
public abstract static class Builder<T extends TableDefinition, B extends Builder<T, B>> {

Expand Down Expand Up @@ -152,8 +152,8 @@ final int baseHashCode() {
return Objects.hash(type);
}

final boolean baseEquals(TableDefinition jobConfiguration) {
return Objects.equals(toPb(), jobConfiguration.toPb());
final boolean baseEquals(TableDefinition tableDefinition) {
return Objects.equals(toPb(), tableDefinition.toPb());
}

Table toPb() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,9 @@
import java.util.Objects;

/**
* Google BigQuery view table type. BigQuery's views are logical views, not materialized views,
* which means that the query that defines the view is re-executed every time the view is queried.
* Google BigQuery view table definition. BigQuery's views are logical views, not materialized
* views, which means that the query that defines the view is re-executed every time the view is
* queried.
*
* @see <a href="https://cloud.google.com/bigquery/querying-data#views">Views</a>
*/
Expand Down Expand Up @@ -168,7 +169,7 @@ Table toPb() {
}

/**
* Returns a builder for a BigQuery view type.
* Returns a builder for a BigQuery view definition.
*
* @param query the query used to generate the view
*/
Expand All @@ -177,7 +178,7 @@ public static Builder builder(String query) {
}

/**
* Returns a builder for a BigQuery view type.
* Returns a builder for a BigQuery view definition.
*
* @param query the query used to generate the table
* @param functions user-defined functions that can be used by the query
Expand All @@ -187,7 +188,7 @@ public static Builder builder(String query, List<UserDefinedFunction> functions)
}

/**
* Returns a builder for a BigQuery view type.
* Returns a builder for a BigQuery view definition.
*
* @param query the query used to generate the table
* @param functions user-defined functions that can be used by the query
Expand All @@ -197,7 +198,7 @@ public static Builder builder(String query, UserDefinedFunction... functions) {
}

/**
* Creates a BigQuery view type given the query used to generate the table.
* Creates a BigQuery view definition given the query used to generate the table.
*
* @param query the query used to generate the table
*/
Expand All @@ -206,7 +207,7 @@ public static ViewDefinition of(String query) {
}

/**
* Creates a BigQuery view type given a query and some user-defined functions.
* Creates a BigQuery view definition given a query and some user-defined functions.
*
* @param query the query used to generate the table
* @param functions user-defined functions that can be used by the query
Expand All @@ -216,7 +217,7 @@ public static ViewDefinition of(String query, List<UserDefinedFunction> function
}

/**
* Creates a BigQuery view type given a query and some user-defined functions.
* Creates a BigQuery view definition given a query and some user-defined functions.
*
* @param query the query used to generate the table
* @param functions user-defined functions that can be used by the query
Expand Down

0 comments on commit 3502610

Please sign in to comment.