1 /*
2 * (c) Copyright 2006-2020 by rapiddweller GmbH & Volker Bergmann. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, is permitted under the terms of the
6 * GNU General Public License.
7 *
8 * For redistributing this software or a derivative work under a license other
9 * than the GPL-compatible Free Software License as defined by the Free
10 * Software Foundation or approved by OSI, you must first obtain a commercial
11 * license to this software product from rapiddweller GmbH & Volker Bergmann.
12 *
13 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
14 * WITHOUT A WARRANTY OF ANY KIND. ALL EXPRESS OR IMPLIED CONDITIONS,
15 * REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF
16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE
17 * HEREBY EXCLUDED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
18 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
23 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
24 * POSSIBILITY OF SUCH DAMAGE.
25 */
26
27 package com.rapiddweller.benerator.distribution.sequence;
28
29 import com.rapiddweller.benerator.NonNullGenerator;
30 import com.rapiddweller.benerator.distribution.Sequence;
31 import com.rapiddweller.benerator.wrapper.WrapperFactory;
32 import com.rapiddweller.common.BeanUtil;
33 import com.rapiddweller.common.NumberUtil;
34
35 import java.math.BigDecimal;
36
37 import static com.rapiddweller.common.NumberUtil.toDouble;
38 import static com.rapiddweller.common.NumberUtil.toLong;
39
40 /**
41 * {@link Sequence} implementation that implements a 'shuffle' behavior,
42 * by continuously incrementing a base value by a constant value and,
43 * when iterated through the number range, restarts with a value incremented by one.
44 * The numbers generated by a related generator instance is unique as long as the
45 * generator is not reset.<br/>
46 * <br/>
47 * Created at 30.06.2009 06:57:35
48 *
49 * @author Volker Bergmann
50 * @since 0.6.0
51 */
52 public class ShuffleSequence extends Sequence {
53
54 private BigDecimal increment;
55
56 /**
57 * Instantiates a new Shuffle sequence.
58 */
59 public ShuffleSequence() {
60 this(null);
61 }
62
63 /**
64 * Instantiates a new Shuffle sequence.
65 *
66 * @param increment the increment
67 */
68 public ShuffleSequence(BigDecimal increment) {
69 this.increment = null;
70 }
71
72 @Override
73 public <T extends Number> NonNullGenerator<T> createNumberGenerator(
74 Class<T> numberType, T min, T max, T granularity, boolean unique) {
75 if (increment == null) {
76 increment = BigDecimal.valueOf(2);
77 }
78 if (max == null) {
79 max = NumberUtil.maxValue(numberType);
80 }
81 NonNullGenerator<? extends Number> base;
82 if (BeanUtil.isIntegralNumberType(numberType)) {
83 base = new ShuffleLongGenerator(
84 toLong(min), toLong(max), toLong(granularity), toLong(increment));
85 } else {
86 base = new ShuffleDoubleGenerator(
87 toDouble(min), toDouble(max), toDouble(granularity), toDouble(increment));
88 }
89 return WrapperFactory.asNonNullNumberGeneratorOfType(numberType, base, min, granularity);
90 }
91
92 }