IRISLIB database
PopulateUtils Class Reference

Static Public Member Functions

_.Library.String ArrayElement (array)
 Return a random array element. More...
 
 BuildReferenceSample (class, sample, size, selpct)
 Return an array of ids selected randomly from the. More...
 
_.Library.Status BuildValueSetSQL (cptr, cext, table, column, size, _.Library.Integer verbose)
 Populate a value set from a query.
 
_.Library.String City ()
 Return a random city name.
 
_.Library.String Color ()
 Return a random color name (one of 5 possible values).
 
_.Library.String Company ()
 Return a random company name.
 
_.Library.Integer Currency (_.Library.Integer min, _.Library.Integer max)
 Return a random currency value between min and max (if present).
 
_.Library.Date Date (_.Library.Date min, _.Library.Integer max)
 Return a random date value in InterSystems IRIS $H format.
 
_.Library.String ExtentValue (_.Library.Integer cptr, _.Library.Integer cext)
 Return a random value from a concrete value extent.
 
_.Library.String FirstName (_.Library.String gender)
 Return a string containing a random first name. More...
 
_.Library.Integer Float (_.Library.Float min, _.Library.Float max, _.Library.Integer scale)
 Return a random floating point value between min More...
 
_.Library.Integer Integer (_.Library.Integer min, _.Library.Integer max)
 Return a random integer value between min More...
 
_.Library.String LastName ()
 Return a string containing a random last name.
 
_.Library.String Mission ()
 Returns a string containing a randomly generated corporate mission statement.
 
_.Library.String Name (_.Library.String gender)
 Return a string containing a random name as lastname,firstname. More...
 
_.Library.PosixTime PosixTime (_.Library.PosixTime min, _.Library.PosixTime max)
 Return a random PosixTime value that is between the specified min and max PosixTime values. More...
 
_.Library.String Product ()
 Return a random product name (one of 4 possible values).
 
_.Library.Integer Random (_.Library.Integer n)
 Return a random number from 0-n using a random number generator that is. More...
 
_.Library.String SSN ()
 Return a random U.S. More...
 
_.Library.String Street ()
 Return a random street address.
 
_.Library.String String (_.Library.Integer len)
 Return a string value of the form <random character>_<random number less than 9999> and whose length. More...
 
_.Library.String StringMin (_.Library.Integer minlen, _.Library.Integer maxlen)
 Return a random string value whose length is at least minlen and not greater than maxlen.
 
_.Library.String Syllable (_.Library.Integer maxlen)
 Return a string of random syllables and spaces. More...
 
_.Library.String TimeStamp (_.Library.TimeStamp min, _.Library.TimeStamp max)
 Return a random TimeStamp value that is between the specified min and max timestamp values. More...
 
_.Library.String Title ()
 Return a random job title.
 
_.Library.String USPhone ()
 Return a random U.S. More...
 
_.Library.String USState ()
 Return a random U.S. More...
 
_.Library.String USZip ()
 Return a random U.S. More...
 
_.Library.String ValueList (vallist)
 Return a random piece from a delimited list. More...
 
_.Library.String VarString (_.Library.Integer maxlen)
 Return a random string value of random length. More...
 

Detailed Description

For details on using this class, see Using the Populate Utility.

The <CLASS>PopulateUtils</CLASS> class contains a number of utility methods used by the <CLASS>Populate</CLASS> class.

Member Function Documentation

◆ ArrayElement()

_.Library.String ArrayElement (   array)
static

Return a random array element.

For details on using this class, see Using the Populate Utility.

The <CLASS>PopulateUtils</CLASS> class contains a number of utility methods used by the <CLASS>Populate</CLASS> class.

◆ BuildReferenceSample()

BuildReferenceSample (   class,
  sample,
  size,
  selpct 
)
static

Return an array of ids selected randomly from the.

Extent query of the class in the sample parameter. The array is of the form: sample=n sample(1)=id1,sample(2)=id2,...,sample(n)=idn Parameters: class - the class to retrieve samples from sample - the array of samples (returned) size - the maximum number of samples to retrieve selpct - the percentage of instances to be randomly selected. for example, 25 means approximately 25% of the instances will be selected (1 in 4).

◆ FirstName()

_.Library.String FirstName ( _.Library.String  gender)
static

Return a string containing a random first name.

gender is a optional string used to control the gender of the generated name: 1 is Male, 2 = Female, "" is either.

◆ Float()

Return a random floating point value between min

and max (if present).

◆ Integer()

Return a random integer value between min

and max (if present).

◆ Name()

Return a string containing a random name as lastname,firstname.

gender is a optional string used to control the gender of the generated name: 1 is Male, 2 = Female, "" is either.

◆ PosixTime()

Return a random PosixTime value that is between the specified min and max PosixTime values.

If either min or max is not a valid PosixTime value, then the default value is used instead. The default min value is -6919738016441081856 (1900-01-01 00:00:00) The default max value is the current timestamp value

◆ Random()

_.Library.Integer Random ( _.Library.Integer  n)
static

Return a random number from 0-n using a random number generator that is.

seeded by <class>Library.Populate</class>.

◆ SSN()

_.Library.String SSN ( )
static

Return a random U.S.

Social Security Number.

◆ String()

Return a string value of the form <random character>_<random number less than 9999> and whose length.

does not exceed len.

◆ Syllable()

_.Library.String Syllable ( _.Library.Integer  maxlen)
static

Return a string of random syllables and spaces.

The algorithm uses several syllable 'lists'. First, a list is randomly chosen. Then a syllable from that list is chosen and added to the string. Then, if a random boolean is TRUE, a space is appended. Syllables are added to the string until the string length exceeds a random length less than or equal to the parameter maxlen.

◆ TimeStamp()

Return a random TimeStamp value that is between the specified min and max timestamp values.

The default min value is the default <method>Date</method> min date value with time = 0. The default max value is the default <method>Date</method> max date value with time = 86399 (23:59:59). If either min or max is not a valid TimeStamp value, then the default value is used instead.

◆ USPhone()

_.Library.String USPhone ( )
static

Return a random U.S.

phone number.

◆ USState()

_.Library.String USState ( )
static

Return a random U.S.

state abbreviation.

◆ USZip()

_.Library.String USZip ( )
static

Return a random U.S.

Zone Improvement Plan (ZIP) code.

◆ ValueList()

_.Library.String ValueList (   vallist)
static

Return a random piece from a delimited list.

The first character in the list is the delimiter.

◆ VarString()

_.Library.String VarString ( _.Library.Integer  maxlen)
static

Return a random string value of random length.

up to maxlen characters.