Merge pull request #7 from marmbrus/docFixes

Fix broken scala doc links / warnings.

Author: marmbrus

build.sbt

@@ -8,6 +8,8 @@ version := "0.1-SNAPSHOT"
 
 scalaVersion := "2.10.3"
 
+scalacOptions ++= Seq("-deprecation", "-feature", "-unchecked")
+
 resolvers += "Local Maven Repository" at "file://"+Path.userHome.absolutePath+"/.m2/repository"
 
 libraryDependencies += "org.apache.spark" %% "spark-core" % "0.9.0-incubating-SNAPSHOT"

src/main/scala/catalyst/analysis/Analyzer.scala

@@ -67,8 +67,8 @@ class Analyzer(catalog: Catalog, registry: FunctionRegistry, caseSensitive: Bool
   }
 
   /**
-   * Replaces [[UnresolvedAttribute]]s with concrete [[AttributeReference]]s
-   * from a logical plan node's children.
+   * Replaces [[UnresolvedAttribute]]s with concrete
+   * [[expressions.AttributeReference AttributeReferences]] from a logical plan node's children.
    */
   object ResolveReferences extends Rule[LogicalPlan] {
     def apply(plan: LogicalPlan): LogicalPlan = plan transformUp {
@@ -85,7 +85,7 @@ class Analyzer(catalog: Catalog, registry: FunctionRegistry, caseSensitive: Bool
   }
 
   /**
-   * Replaces [[UnresolvedFunction]]s with concrete [[Expression]]s.
+   * Replaces [[UnresolvedFunction]]s with concrete [[expressions.Expression Expressions]].
    */
   object ResolveFunctions extends Rule[LogicalPlan] {
     def apply(plan: LogicalPlan): LogicalPlan = plan transform {
@@ -141,7 +141,7 @@ class Analyzer(catalog: Catalog, registry: FunctionRegistry, caseSensitive: Bool
     }
 
     /**
-     * Returns true if [[exprs]] contains a star.
+     * Returns true if `exprs` contains a [[Star]].
      */
     protected def containsStar(exprs: Seq[NamedExpression]): Boolean =
       exprs.collect { case _: Star => true }.nonEmpty

src/main/scala/catalyst/analysis/typeCoercion.scala

@@ -43,11 +43,11 @@ object ConvertNaNs extends Rule[LogicalPlan] {
  * Loosely based on rules from "Hadoop: The Definitive Guide" 2nd edition, by Tom White
  *
  * The implicit conversion rules can be summarized as follows:
- * $ - Any integral numeric type can be implicitly converted to a wider type.
- * $ - All the integral numeric types, FLOAT, and (perhaps surprisingly) STRING can be implicitly
+ *   - Any integral numeric type can be implicitly converted to a wider type.
+ *   - All the integral numeric types, FLOAT, and (perhaps surprisingly) STRING can be implicitly
  *     converted to DOUBLE.
- * $ - TINYINT, SMALLINT, and INT can all be converted to FLOAT.
- * $ - BOOLEAN types cannot be converted to any other type.
+ *   - TINYINT, SMALLINT, and INT can all be converted to FLOAT.
+ *   - BOOLEAN types cannot be converted to any other type.
  *
  * String conversions are handled by the PromoteStrings rule.
  */

src/main/scala/catalyst/dsl.scala

@@ -1,5 +1,7 @@
 package catalyst
 
+import scala.language.implicitConversions
+
 import analysis.UnresolvedAttribute
 import expressions._
 import plans._

src/main/scala/catalyst/errors/package.scala

@@ -17,8 +17,8 @@ package object errors {
   }
 
   /**
-   *  Wraps any exceptions that are thrown while executing [[f]] in an [[OptimizationException]], attaching the provided
-   *  [[tree]].
+   *  Wraps any exceptions that are thrown while executing `f` in an [[OptimizationException]],
+   *  attaching the provided `tree`.
    */
   def attachTree[TreeType <: TreeNode[_], A](tree: TreeType, msg: String = "")(f: => A): A = {
     try f catch {
@@ -27,8 +27,8 @@ package object errors {
   }
 
   /**
-   * Executes [[f]] which is expected to throw an OptimizationException. The first tree encountered in the stack
-   * of exceptions of type [[TreeType]] is returned.
+   * Executes `f` which is expected to throw an OptimizationException. The first tree encountered in
+   * the stack of exceptions of type `TreeType` is returned.
    */
   def getTree[TreeType <: TreeNode[_]](f: => Unit): TreeType = ??? // TODO: Implement
 }

src/main/scala/catalyst/examples/SchemaRddExample.scala

@@ -15,13 +15,14 @@ object SchemaRddExample {
       ("12/2/2013", "WARN: blah blah") :: Nil
     )
 
+    val dateRegEx = "(\\d+)\\/(\\d+)\\/(\\d+)".r
     /**
      * Example using the symbol based API.  In this example, the attribute names that are passed to
      * the first constructor are resolved during catalyst's analysis phase.  Then at runtime only
      * the requested attributes are passed to the UDF.  Since this analysis occurs at runtime,
      * the developer must manually annotate their function with the correct argument types.
      */
-    val filtered = testLogs.filter('date)((date: String) => new java.util.Date(date).getDay == 1)
+    val filtered = testLogs.filter('date) { case dateRegEx(_,day,_) => day.toInt == 1 }
     filtered.toRdd.collect.foreach(println)
 
 
@@ -35,7 +36,7 @@ object SchemaRddExample {
      * being resolved at runtime.  Thus, we cannot return typed results.  As such all dynamic calls
      * always return strings.
      */
-    val filtered2 = testLogs.filter(row => new java.util.Date(row.date).getDay == 1)
+    val filtered2 = testLogs.filter( _.date match { case dateRegEx(_,day,_) => day.toInt == 1 } )
     filtered2.toRdd.collect.foreach(println)
   }
 }

src/main/scala/catalyst/examples/ViewsExample.scala

@@ -1,4 +1,5 @@
 package catalyst
+package examples
 
 import catalyst.analysis.UnresolvedRelation
 import catalyst.plans.Inner

src/main/scala/catalyst/execution/MetastoreCatalog.scala

@@ -5,7 +5,7 @@ import org.apache.hadoop.hive.conf.HiveConf
 import org.apache.hadoop.hive.metastore.api.{FieldSchema, Partition, Table, StorageDescriptor, SerDeInfo}
 import org.apache.hadoop.hive.metastore.HiveMetaStoreClient
 import org.apache.hadoop.hive.ql.plan.TableDesc
-import org.apache.hadoop.hive.serde2.Deserializer
+import org.apache.hadoop.hive.serde2.AbstractDeserializer
 import org.apache.hadoop.mapred.InputFormat
 
 import analysis.Catalog
@@ -100,7 +100,7 @@ case class MetastoreRelation(databaseName: String, tableName: String, alias: Opt
   }
 
   val tableDesc = new TableDesc(
-    Class.forName(table.getSd.getSerdeInfo.getSerializationLib).asInstanceOf[Class[Deserializer]],
+    Class.forName(table.getSd.getSerdeInfo.getSerializationLib).asInstanceOf[Class[AbstractDeserializer]],
     Class.forName(table.getSd.getInputFormat).asInstanceOf[Class[InputFormat[_,_]]],
     Class.forName(table.getSd.getOutputFormat),
     hiveQlTable.getMetadata

src/main/scala/catalyst/execution/SharkContext.scala

@@ -30,7 +30,7 @@ class SharkContext(
   import SharkContext._
 
   /**
-   * Execute the command and return the results as a sequence. Each element
+   * Execute the command using Hive and return the results as a sequence. Each element
    * in the sequence is one row.
    */
   def runHive(cmd: String, maxRows: Int = 1000): Seq[String] = {

src/main/scala/catalyst/execution/SharkInstance.scala

@@ -2,6 +2,7 @@ package catalyst
 package execution
 
 import java.io.File
+import scala.language.implicitConversions
 
 import analysis.{SimpleAnalyzer, Analyzer}
 import frontend.hive._