io.nosqlbench.virtdata.library.realer.FirstNamesAutoDocsInfo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of virtdata-lib-realer Show documentation

With inspiration from other libraries

There is a newer version: 5.17.0

// This file is auto-generated.
package io.nosqlbench.virtdata.library.realer;

import io.nosqlbench.nb.annotations.Service;
import io.nosqlbench.virtdata.api.annotations.Category;
import io.nosqlbench.virtdata.api.processors.DocCtorData;
import io.nosqlbench.virtdata.api.processors.DocForFuncCtor;
import io.nosqlbench.virtdata.api.processors.DocFuncData;
import java.lang.String;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;

@Service(
    value = DocFuncData.class,
    selector = "io.nosqlbench.virtdata.library.realer.FirstNames"
)
public class FirstNamesAutoDocsInfo implements DocFuncData {
  public String getClassName() {
    return "FirstNames";
  }

  public String getPackageName() {
    return "io.nosqlbench.virtdata.library.realer";
  }

  public String getClassJavadoc() {
    return "Return a pseudo-randomly sampled first name from the last US census data on first names\n"
            + "occurring more than 100 times. Both male and female names are combined in this function.\n";
  }

  public String getInType() {
    return "long";
  }

  public String getOutType() {
    return "java.lang.String";
  }

  public Category[] getCategories() {
    return new Category[] { Category.premade };
  }

  public List getCtors() {
    return new ArrayList() {{
          add(new DocForFuncCtor("FirstNames", "", 
            new LinkedHashMap() {{
            }},
            new ArrayList>() {{
              add(new ArrayList() {{
                add("FirstNames()");
                add("select a random first name based on the chance of seeing it in the census data");
              }});
            }}
          ));
          add(new DocForFuncCtor("FirstNames", "", 
            new LinkedHashMap() {{
              put("modifier","java.lang.String");
            }},
            new ArrayList>() {{
              add(new ArrayList() {{
                add("FirstNames('map')");
                add("select over the first names by probability as input varies from 1L to Long.MAX_VALUE");
              }});
            }}
          ));
        }};
  }
}