RangeSet (Groovy Documentation)

Summary:
Constructor
Method

| Detail:
Constructor
Method

com.cedarsoftware.ncube.RangeSet

All Implemented Interfaces and Traits:

java.lang.Comparable
```
@groovy.transform.CompileStatic
class RangeSet
extends java.lang.Object
```
This class is used to represent a Set of values, where the values can be a Comparable or a Range. This allows "grouping", or "OR", or SQL "IN" type of logic when matching a given value against an axis, greatly reducing having duplicate cells in an ncube.
Authors:
John DeRegnaucourt ([email protected])
Copyright (c) Cedar Software LLC

Licensed 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.

Constructor Summary

Constructors
Constructor and description
`RangeSet ()`
`RangeSet (java.lang.Comparable c)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`add(java.lang.Comparable c)`
	`void`	`clear()`
	`int`	`compareTo(RangeSet that)`
	`boolean`	`contains(java.lang.Comparable value)` Parameters: `value` - to compare with this RangeSet to determine if the value is within.
	`boolean`	`equals(java.lang.Object other)`
	`java.lang.Comparable`	`get(int index)`
	`int`	`hashCode()`
	`java.util.Iterator<java.lang.Comparable>`	`iterator()`
	`boolean`	`overlap(RangeSet that)` Returns: boolean true if the points and line segments represented by these two RangeSets overlap.
	`int`	`size()`
	`java.lang.String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Constructor Detail
  - RangeSet()
  - RangeSet(java.lang.Comparable c)
- Method Detail
  - void add(java.lang.Comparable c)
  - void clear()
  - int compareTo(RangeSet that)
  - boolean contains(java.lang.Comparable value)
    
    Parameters:
    value - to compare with this RangeSet to determine if the value is within. For example, {v1, v2, v6-v25, v30} - in this case, the passed in value must match v1, v2, or v30, or fall within [v6, v25).
    Returns:
    boolean true if the passed in value can be found within this RangeSet instance. That means an individual value in this set must match the passed in value, or a Range inside this RangeSet must include the passed in value.
  - boolean equals(java.lang.Object other)
  - java.lang.Comparable get(int index)
  - int hashCode()
  - java.util.Iterator<java.lang.Comparable> iterator()
  - boolean overlap(RangeSet that)
    
    Returns:
    boolean true if the points and line segments represented by these two RangeSets overlap. Assumption that the Range objects 'low' value is less than the 'high' value.
  - int size()
  - java.lang.String toString()

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation