Data Types for User-Defined Data Pipeline Functions

this description provides the {{ocient}} packages that support the functionality for user defined data pipeline functions classes com ocient streaming schema ocientcolumntype the class that enumerates all defined column types in the ocient system enum value type none type inferred type deleted type int type bigint type float type double type varchar type ipv4 type timestamp type date type boolean type binary type smallint type byte type uuid type hash type ip type st point type time type decimal type array type tuple type st linestring type st polygon com ocient streaming schema ocientcolumntypearguments the class that describes arguments of a column type not all column types require arguments modifier and type field and description public static final ocientcolumntypearguments none — a default instance indicating no arguments are necessary for a column type com ocient streaming schema ocientcolumntypearguments decimal a subclass of ocientcolumntypearguments that includes information for type decimal modifier and type field and description public int precision — the number of digits in a number public int scale — the number of digits to the right of the decimal point in a number public boolean fullformat — true if the serialized format includes one byte for precision and one byte for scale you should always set this to true constructor public decimal(int precision, int scale, boolean fullformat) constructs a newly allocated ocientcolumntypearguments for ocientcolumntype type decimal com ocient streaming schema ocientcolumntypearguments hash a subclass of ocientcolumntypearguments that includes information for type hash modifier and type field and description public int length — the number of bytes in the hash value constructor public hash(int length) — constructs a newly allocated ocientcolumntypearguments for ocientcolumntype type hash com ocient streaming schema ocientcolumntypearguments array a subclass of ocientcolumntypearguments that includes information for type array modifier and type field and description public ocientcolumntype elementtype — the array element type public ocientcolumntypearguments elementtypearguments — type arguments for the array element type constructor public array(ocientcolumntype elementtype) — constructs a newly allocated ocientcolumntypearguments for an array of elementtype the elementtypearguments field initializes to ocientcolumntypearguments none public array(ocientcolumntype elementtype, ocientcolumntypearguments elementtypearguments, int offsetsizeoverride) — constructs a newly allocated ocientcolumntypearguments for an array of elementtype you should set offsetoverride to 0 com ocient streaming schema ocientcolumntypearguments topleveltuple a subclass of tuple that includes information for top level tuples modifier and type field and description private list\<ocientcolumn> elementocientcolumns — list of tuple element types modifier and type method and description public list\<ocientcolumntypearguments> gettupletypearguments() — returns the list of tuple element type arguments public list\<ocientcolumntype> gettupletypes() — returns the list of tuple element types public list\<ocientcolumn> getelementocientcolumns() — returns the list of tuple element types paired with their arguments constructor public topleveltuple(list\<ocientcolumn> elementocientcolumns) — constructs a newly allocated ocientcolumntypearguments for a ocientcolumntype type tuple com ocient streaming schema ocientcolumn represents an ocient column with information parsed from metadata of the ocient system modifier and type method and description public string name() — the name of the column public ocientcolumntype type() — the data type of the column public ocientcolumntypearguments typearguments() — some column types, for example decimal , have arguments that are required to fully understand their format a relevant subclass of ocientcolumntypearguments returns, as appropriate, or ocientcolumntypearguments none public boolean required() — returns true if the user is required to provide this column this is generally the case for non defaulted, non nullable columns public boolean nullable() — returns true if this column is configured as nullable, false otherwise com ocient streaming data types gis coordinate represents a two dimensional cartesian coordinate modifier and type field and description public double x — the x coordinate of the point public double y — the y coordinate of the point modifier and type method and description public double x() — returns the x coordinate of this point public double y() — returns the y coordinate of this point constructor public coordinate(double x, double y) — constructs a newly allocated coordinate com ocient streaming data types gis stpoint represents a two dimensional cartesian coordinate modifier and type field and description public coordinate coordinate — the ordered, x and y coordinate pair modifier and type method and description public static stpoint fromwkt(string text) — parses an stpoint from the wkt text public static stpoint fromewkt(string text) — parses an stpoint from the ewkt text public double getx() — returns the x coordinate of this point public double gety() — returns the y coordinate of this point public stlinestring tolinestring() — promotes the stpoint to an stlinestring container useful when representing a geometry collection consisting of stlinestring and stpoint elements public stpolygon topolygon() — promotes the stpoint to an stpolygon container useful when representing a geometry collection consisting of any geospatial element type constructor public stpoint(coordinate coordinate) — constructs a newly allocated stpoint com ocient streaming data types gis stlinestring geometric type that is composed of a sequence of n points modifier and type field and description public stpoint\[] points — the ordered sequence of points in the linestring modifier and type method and description public static stlinestring fromwkt(string text) — parses an stlinestring from the wkt text public static stlinestring fromewkt(string text) — parses an stlinestring from the ewkt text public stpoint\[] points() — returns the points of this linestring public stlinestring tolinestring() — returns this public stpolygon topolygon() — promotes the stlinestring to an stpolygon container useful when representing a geometry collection consisting of any geospatial element type constructor public stlinestring(stpoint\[] points) — constructs a newly allocated stlinestring com ocient streaming data types gis stpolygon geometric type composed of n closed linestrings modifier and type field and description public stlinestring exteriorring — the exterior ring of the polygon public stlinestring\[] interiorrings — the interior rings of the polygon modifier and type method and description public static stlinestring fromwkt(string text) — parses an stpolygon from the wkt text public static stlinestring fromewkt(string text) — parses an stpolygon from the ewkt text public stlinestring exteriorring() — returns the exterior linestring public stlinestring\[] interiorrings() — returns the interior linestrings public stpolygon topolygon() — returns this constructor public stpolygon(stlinestring exteriorring, stlinestring\[] interiorrings) — constructs a newly allocated stpolygon com ocient streaming data types timestamp timestamp represented as nanoseconds from the {{unix}} epoch modifier and type method and description public long value() — returns the number of nanoseconds after the unix epoch constructor public timestamp(long nanosfromepoch) — constructs a newly allocated timestamp com ocient streaming data types time time that is represented as nanoseconds from midnight ( 00 00 00 ) modifier and type method and description public long value() — returns the number of nanoseconds after midnight constructor public time(long nanosfrommidnight) — constructs a newly allocated time com ocient streaming data types decimal a class representing a decimal number with binary coded decimal (bcd) storage, supporting specified precision and scale modifier and type field and description public static long max precision — the maximum supported precision in the database modifier and type method and description public static decimal fromstring(string s, byte precision, byte scale) creates a decimal object from a string representation with the specified precision and scale s — the string representation of the decimal (e g , "123 45" , " 0 1" ) precision — the precision (total number of digits) of the decimal scale — the scale (number of digits after the decimal point) of the decimal public static decimal frombigdecimal(java math bigdecimal d, byte precision, byte scale) creates a decimal object from a bigdecimal , ensuring compatibility with the specified precision and scale d — the bigdecimal to convert precision — the precision (total number of digits) of the decimal scale — the scale (number of digits after the decimal point) of the decimal public static decimal fromdouble(double d, byte precision, byte scale) creates a decimal object from a double value with the specified precision and scale d — the double to convert precision — the precision (total number of digits) of the decimal scale — the scale (number of digits after the decimal point) of the decimal public string tostring() — returns the decimal string representation of this decimal public long aslong() — converts this decimal object to a long, truncating any fractional part public double asdouble() — converts this decimal object to a double, preserving the full value including the fractional part public byte\[] bcd() — returns the bcd representation of this decimal object public byte\[] getfullformat() — returns the full format representation, including precision and scale bytes followed by the bcd data padded to max precision public int precision() — returns the precision of this decimal object public int scale() — returns the scale of this decimal object com ocient streaming data types ocienttuple a class representing a tuple with a defined schema of column types and associated values supports fixed length and variable length elements modifier and type method and description public int numvalues() — returns the number of values currently stored in this tuple public void setvalue(int index, object value) sets or updates the value at the specified index, ensuring type compatibility index — the index of the value to set (0 based) value — the value to set must match the column type at the index public void set(list\<object> values) sets or resets all values in the tuple from the provided list values — the list of values to set must match the schema size and types public string tostring() — returns a string representation of this tuple, including its schema and values (e g , "tuple\<int,double>(1,2 0)" ) public list\<object> get() — returns the list of values in this tuple, in order public list\<ocientcolumntype> gettypes() — returns the list of column types defining the schema of this tuple, in order public list\<ocientcolumntypearguments> gettypeargs() — returns the list of type arguments corresponding to the column types of this tuple, in order constructor public ocienttuple(list\<ocientcolumntype> types, list\<ocientcolumntypearguments> typeargs) constructs an empty tuple with the specified schema of column types and type arguments types — the list of column types defining the tuple schema typeargs — the list of type arguments corresponding to each column type related links docid\ l8tdfpfzzvzeyabc2h7bq