Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [%SYS] >  [%Library] >  [PopulateUtils]
Private  Storage   

class %Library.PopulateUtils

The %PopulateUtils class contains a number of utility methods used by the %Populate class.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
32


Summary

Methods
ArrayElement BuildReferenceSample BuildValueSetSQL CDate
City Color Company Counter
Currency Date ExtentValue FirstName
Float Integer LastName Mission
Name PosixTime Product Random
SSN Street String StringMin
Syllable TimeStamp Title USPhone
USState USZip ValueList VarString


Methods

• classmethod ArrayElement(ByRef array) as %String
Return a random array element.
• classmethod BuildReferenceSample(class, sample, size=500, selpct=25)
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).
• classmethod BuildValueSetSQL(cptr, cext, table, column, size=500, verbose As %Integer = 0) as %Status
Populate a value set from a query
• classmethod CDate(format As %Integer = 1, min As %Date = 30000, max As %Date = 55000) as %String
• classmethod City() as %String
Return a random city name.
• classmethod Color() as %String
Return a random color name (one of 5 possible values).
• classmethod Company() as %String
Return a random company name.
• classmethod Counter(counter As %String = "c", initial As %Integer = 1) as %String
• classmethod Currency(min As %Integer = 0, max As %Integer = 10000) as %Integer
Return a random currency value between min and max (if present).
• classmethod Date(min As %Date, max As %Integer) as %Date
Return a random date value in InterSystems IRIS $H format.
• classmethod ExtentValue(cptr As %Integer, cext As %Integer) as %String
Return a random value from a concrete value extent.
• classmethod FirstName(gender As %String = "") as %String
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.

• classmethod Float(min As %Float = 0, max As %Float = 10000, scale As %Integer = 0) as %Integer
Return a random floating point value between min and max (if present).
• classmethod Integer(min As %Integer = 0, max As %Integer = 1000000000) as %Integer
Return a random integer value between min and max (if present).
• classmethod LastName() as %String
Return a string containing a random last name.
• classmethod Mission() as %String
Returns a string containing a randomly generated corporate mission statement.
• classmethod Name(gender As %String = "") as %String
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.

• classmethod PosixTime(min As %PosixTime = "", max As %PosixTime = "") as %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
• classmethod Product() as %String
Return a random product name (one of 4 possible values).
• classmethod Random(n As %Integer) as %Integer
Return a random number from 0-n using a random number generator that is seeded by %Library.Populate.
• classmethod SSN() as %String
Return a random U.S. Social Security Number.
• classmethod Street() as %String
Return a random street address.
• classmethod String(len As %Integer = 1) as %String
Return a string value of the form _ and whose length does not exceed len.
• classmethod StringMin(minlen As %Integer = 1, maxlen As %Integer = 1) as %String
Return a random string value whose length is at least minlen and not greater than maxlen.
• classmethod Syllable(maxlen As %Integer = 30) as %String
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.
• classmethod TimeStamp(min As %TimeStamp, max As %TimeStamp) as %String
Return a random TimeStamp value that is between the specified min and max timestamp values. The default min value is the default Date min date value with time = 0. The default max value is the default Date 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.
• classmethod Title() as %String
Return a random job title.
• classmethod USPhone() as %String
Return a random U.S. phone number.
• classmethod USState() as %String
Return a random U.S. state abbreviation.
• classmethod USZip() as %String
Return a random U.S. Zone Improvement Plan (ZIP) code.
• classmethod ValueList(vallist) as %String
Return a random piece from a delimited list. The first character in the list is the delimiter.
• classmethod VarString(maxlen As %Integer = 1) as %String
Return a random string value of random length up to maxlen characters.


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.