From cb2cc89c8cf873915137a25926341384d8299e1e Mon Sep 17 00:00:00 2001 From: Chungmin Lee Date: Mon, 12 Apr 2021 21:26:34 +0900 Subject: [PATCH] Update Scaladoc --- .../microsoft/hyperspace/index/IndexSignatureProvider.scala | 2 ++ .../com/microsoft/hyperspace/index/PlanSignatureProvider.scala | 2 ++ .../index/sources/default/DefaultFileBasedRelation.scala | 2 ++ .../hyperspace/index/sources/delta/DeltaLakeRelation.scala | 2 ++ .../hyperspace/index/sources/iceberg/IcebergRelation.scala | 2 ++ .../com/microsoft/hyperspace/index/sources/interfaces.scala | 3 +++ 6 files changed, 13 insertions(+) diff --git a/src/main/scala/com/microsoft/hyperspace/index/IndexSignatureProvider.scala b/src/main/scala/com/microsoft/hyperspace/index/IndexSignatureProvider.scala index 5328d5971..63b862fbd 100644 --- a/src/main/scala/com/microsoft/hyperspace/index/IndexSignatureProvider.scala +++ b/src/main/scala/com/microsoft/hyperspace/index/IndexSignatureProvider.scala @@ -29,6 +29,8 @@ import com.microsoft.hyperspace.util.fingerprint.{Fingerprint, FingerprintBuilde * * If the plan does not comply with [[FileBasedSignatureProvider]] or [[PlanSignatureProvider]] * requirements for signature computation, then no signature will be provided for the plan. + * + * @param fbf [[FingerprintBuilderFactory]] used for building fingerprints */ class IndexSignatureProvider(fbf: FingerprintBuilderFactory) extends LogicalPlanSignatureProvider { diff --git a/src/main/scala/com/microsoft/hyperspace/index/PlanSignatureProvider.scala b/src/main/scala/com/microsoft/hyperspace/index/PlanSignatureProvider.scala index 3532e32f9..cef578d69 100644 --- a/src/main/scala/com/microsoft/hyperspace/index/PlanSignatureProvider.scala +++ b/src/main/scala/com/microsoft/hyperspace/index/PlanSignatureProvider.scala @@ -24,6 +24,8 @@ import com.microsoft.hyperspace.util.fingerprint.{Fingerprint, FingerprintBuilde * [[PlanSignatureProvider]] provides signature for a logical plan based on * the type of operators in it. * A plan needs to have at least one operator so its signature can be generated. + * + * @param fbf [[FingerprintBuilderFactory]] used for building fingerprints */ class PlanSignatureProvider(fbf: FingerprintBuilderFactory) extends LogicalPlanSignatureProvider { diff --git a/src/main/scala/com/microsoft/hyperspace/index/sources/default/DefaultFileBasedRelation.scala b/src/main/scala/com/microsoft/hyperspace/index/sources/default/DefaultFileBasedRelation.scala index c1e6917b2..87ecb18a3 100644 --- a/src/main/scala/com/microsoft/hyperspace/index/sources/default/DefaultFileBasedRelation.scala +++ b/src/main/scala/com/microsoft/hyperspace/index/sources/default/DefaultFileBasedRelation.scala @@ -41,6 +41,8 @@ class DefaultFileBasedRelation(spark: SparkSession, override val plan: LogicalRe /** * Computes the signature of the current relation. + * + * @param fb [[FingerprintBuilder]] used for building fingerprints */ override def signature(fb: FingerprintBuilder): Option[Fingerprint] = plan.relation match { case HadoopFsRelation(location: PartitioningAwareFileIndex, _, _, _, _, _) => diff --git a/src/main/scala/com/microsoft/hyperspace/index/sources/delta/DeltaLakeRelation.scala b/src/main/scala/com/microsoft/hyperspace/index/sources/delta/DeltaLakeRelation.scala index 4a3d518e4..276cdeee3 100644 --- a/src/main/scala/com/microsoft/hyperspace/index/sources/delta/DeltaLakeRelation.scala +++ b/src/main/scala/com/microsoft/hyperspace/index/sources/delta/DeltaLakeRelation.scala @@ -36,6 +36,8 @@ class DeltaLakeRelation(spark: SparkSession, override val plan: LogicalRelation) /** * Computes the signature of the current relation. + * + * @param fb [[FingerprintBuilder]] used for building fingerprints */ override def signature(fb: FingerprintBuilder): Option[Fingerprint] = plan.relation match { case HadoopFsRelation(location: TahoeLogFileIndex, _, _, _, _, _) => diff --git a/src/main/scala/com/microsoft/hyperspace/index/sources/iceberg/IcebergRelation.scala b/src/main/scala/com/microsoft/hyperspace/index/sources/iceberg/IcebergRelation.scala index 53cbb626a..fe0e7613d 100644 --- a/src/main/scala/com/microsoft/hyperspace/index/sources/iceberg/IcebergRelation.scala +++ b/src/main/scala/com/microsoft/hyperspace/index/sources/iceberg/IcebergRelation.scala @@ -45,6 +45,8 @@ class IcebergRelation(spark: SparkSession, override val plan: DataSourceV2Relati /** * Computes the signature of the current relation. + * + * @param fb [[FingerprintBuilder]] used for building fingerprints */ override def signature(fb: FingerprintBuilder): Option[Fingerprint] = plan.source match { case _: IcebergSource => diff --git a/src/main/scala/com/microsoft/hyperspace/index/sources/interfaces.scala b/src/main/scala/com/microsoft/hyperspace/index/sources/interfaces.scala index 011d0ddae..9f930a97b 100644 --- a/src/main/scala/com/microsoft/hyperspace/index/sources/interfaces.scala +++ b/src/main/scala/com/microsoft/hyperspace/index/sources/interfaces.scala @@ -61,6 +61,9 @@ trait FileBasedRelation extends SourceRelation { * * If it is not possible to compute the signature (e.g. there are no files left), * the implementation might return None. + * + * @param fb [[FingerprintBuilder]] used for building fingerprints. + * Use it to compute the signature from discriminating properties of the relation. */ def signature(fb: FingerprintBuilder): Option[Fingerprint]