forked from apache/flink
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[FLINK-2673] [core] Add a comparator for Scala Option type
This closes apache#2017.
- Loading branch information
1 parent
da23ee3
commit c60326f
Showing
4 changed files
with
214 additions
and
5 deletions.
There are no files selected for viewing
157 changes: 157 additions & 0 deletions
157
flink-scala/src/main/scala/org/apache/flink/api/scala/typeutils/OptionTypeComparator.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,157 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package org.apache.flink.api.scala.typeutils | ||
|
|
||
| import org.apache.flink.annotation.Internal | ||
| import org.apache.flink.api.common.typeutils.TypeComparator | ||
| import org.apache.flink.core.memory.{DataInputView, DataOutputView, MemorySegment} | ||
|
|
||
| /** | ||
| * Comparator for [[Option]] values. Note that [[None]] is lesser than any [[Some]] values. | ||
| */ | ||
| @Internal | ||
| class OptionTypeComparator[A]( | ||
| private val ascending: Boolean, | ||
| private val typeComparator: TypeComparator[A] | ||
| ) extends TypeComparator[Option[A]] { | ||
| private var reference: Option[A] = _ | ||
|
|
||
| override def hash(record: Option[A]) = record.hashCode() | ||
|
|
||
| override def compare(first: Option[A], second: Option[A]) = { | ||
| first match { | ||
| case Some(firstValue: A) => | ||
| second match { | ||
| case Some(secondValue: A) => typeComparator.compare(firstValue, secondValue) | ||
| case None => | ||
| if (ascending) { | ||
| 1 | ||
| } else { | ||
| -1 | ||
| } | ||
| } | ||
| case None => | ||
| second match { | ||
| case Some(secondValue) => | ||
| if (ascending) { | ||
| -1 | ||
| } else { | ||
| 1 | ||
| } | ||
| case None => 0 | ||
| } | ||
| } | ||
| } | ||
|
|
||
| override def compareSerialized(firstSource: DataInputView, secondSource: DataInputView) = { | ||
| val firstSome = firstSource.readBoolean() | ||
| val secondSome = secondSource.readBoolean() | ||
|
|
||
| if (firstSome) { | ||
| if (secondSome) { | ||
| typeComparator.compareSerialized(firstSource, secondSource) | ||
| } else { | ||
| if (ascending) { | ||
| 1 | ||
| } else { | ||
| -1 | ||
| } | ||
| } | ||
| } else { | ||
| if (secondSome) { | ||
| if (ascending) { | ||
| -1 | ||
| } else { | ||
| 1 | ||
| } | ||
| } else { | ||
| 0 | ||
| } | ||
| } | ||
| } | ||
|
|
||
| override def extractKeys(record: AnyRef, target: Array[AnyRef], index: Int) = { | ||
| target(index) = record | ||
| 1 | ||
| } | ||
|
|
||
| override def setReference(toCompare: Option[A]) = { | ||
| reference = toCompare | ||
| } | ||
|
|
||
| override def equalToReference(candidate: Option[A]) = { | ||
| compare(reference, candidate) == 0 | ||
| } | ||
|
|
||
| override def compareToReference(referencedComparator: TypeComparator[Option[A]]) = { | ||
| compare(referencedComparator.asInstanceOf[this.type].reference, reference) | ||
| } | ||
|
|
||
| override lazy val getFlatComparators = { | ||
| Array(this).asInstanceOf[Array[TypeComparator[_]]] | ||
| } | ||
|
|
||
| override def getNormalizeKeyLen = 1 + typeComparator.getNormalizeKeyLen | ||
|
|
||
| override def putNormalizedKey( | ||
| record: Option[A], | ||
| target: MemorySegment, | ||
| offset: Int, | ||
| numBytes: Int | ||
| ) = { | ||
| if (numBytes >= 1) { | ||
| record match { | ||
| case Some(v: A) => | ||
| target.put(offset, OptionTypeComparator.OneInByte) | ||
| typeComparator.putNormalizedKey(v, target, offset + 1, numBytes - 1) | ||
| case None => | ||
| target.put(offset, OptionTypeComparator.ZeroInByte) | ||
| var i = 1 | ||
| while (i < numBytes) { | ||
| target.put(offset + i, OptionTypeComparator.ZeroInByte) | ||
| i += 1 | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| override def invertNormalizedKey() = !ascending | ||
|
|
||
| override def readWithKeyDenormalization(reuse: Option[A], source: DataInputView) = { | ||
| throw new UnsupportedOperationException | ||
| } | ||
|
|
||
| override def writeWithKeyNormalization(record: Option[A], target: DataOutputView) = { | ||
| throw new UnsupportedOperationException | ||
| } | ||
|
|
||
| override def isNormalizedKeyPrefixOnly(keyBytes: Int) = { | ||
| typeComparator.isNormalizedKeyPrefixOnly(keyBytes - 1) | ||
| } | ||
|
|
||
| override def supportsSerializationWithKeyNormalization() = false | ||
|
|
||
| override def supportsNormalizedKey() = typeComparator.supportsNormalizedKey() | ||
|
|
||
| override def duplicate() = new OptionTypeComparator[A](ascending, typeComparator) | ||
| } | ||
|
|
||
| object OptionTypeComparator { | ||
| val ZeroInByte = 0.asInstanceOf[Byte] | ||
| val OneInByte = 1.asInstanceOf[Byte] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
31 changes: 31 additions & 0 deletions
31
...-scala/src/test/scala/org/apache/flink/api/scala/typeutils/OptionTypeComparatorTest.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package org.apache.flink.api.scala.typeutils | ||
|
|
||
| import org.apache.flink.api.common.typeutils.ComparatorTestBase | ||
| import org.apache.flink.api.common.typeutils.base.{StringComparator, StringSerializer} | ||
|
|
||
| class OptionTypeComparatorTest extends ComparatorTestBase[Option[String]] { | ||
| override protected def createComparator(ascending: Boolean) = { | ||
| new OptionTypeComparator[String](ascending, new StringComparator(ascending)) | ||
| } | ||
|
|
||
| override protected def createSerializer() = new OptionSerializer[String](new StringSerializer) | ||
|
|
||
| override protected def getSortedTestData = Array(None, Some("a"), Some("b"), Some("c")) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters