IRISLIB database
All Classes Namespaces Functions Variables Pages
NetworkAddress Class Reference

This datatype class validates IP addresses and ports in the format IP|Port. More...

Inheritance diagram for NetworkAddress:
Collaboration diagram for NetworkAddress:

Static Public Member Functions

_.Library.String FormatForHttp (Address)
 This datatype class validates IP addresses and ports in the format IP|Port. More...
 
_.Library.Status IsValid (_, _.Library.RawString Val)
 Tests if the logical value val, which is a string, is valid. More...
 
- Static Public Member Functions inherited from String
_.Library.String DisplayToLogical (_, _.Library.String val)
 Converts the input value val, which is a string, into the logical string format. More...
 
_.Library.String JSONToLogical (_, _.Library.String val)
 If JSONLISTPARAMETER is specified, XSDToLogical is generated which imports using the list specified by JSONLISTPARAMETER.
 
_.Library.String LogicalToDisplay (_, _.Library.String val)
 Converts the value of val, which is in logical format, into a display string. More...
 
_.Library.String LogicalToJSON (_, _.Library.String val)
 If JSONLISTPARAMETER is specified, XSDToLogical is generated which exports using the list specified by JSONLISTPARAMETER.
 
_.Library.String LogicalToXSD (_, _.Library.String val)
 If XMLLISTPARAMETER is specified, XSDToLogical is generated which exports using the list specified by XMLLISTPARAMETER.
 
_.Library.String Normalize (_, _.Library.RawString val)
 Truncates value val to MAXLEN, characters.
 
_.Library.String XSDToLogical (_, _.Library.String val)
 If XMLLISTPARAMETER is specified, XSDToLogical is generated which imports using the list specified by XMLLISTPARAMETER.
 

Additional Inherited Members

- Static Public Attributes inherited from String
 COLLATION = None
 The default collation value used for this data type. More...
 
 CONTENT = None
 XML element content "MIXED" for mixed="true" and "STRING" or "ESCAPE" for mixed="false". More...
 
 DISPLAYLIST = None
 Used for enumerated (multiple-choice) attributes. More...
 
 ESCAPE = None
 Controls the translate table used to escape content when CONTENT="MIXED" is specified.
 
 JSONLISTPARAMETER = None
 Used to specify the name of the parameter which contains the enumeration list for JSON values. More...
 
 JSONTYPE = None
 JSONTYPE is JSON type used for this datatype.
 
 MAXLEN = None
 The maximum number of characters the string can contain. More...
 
 MINLEN = None
 The minimum number of characters the string can contain.
 
 PATTERN = None
 A pattern which the string should match. More...
 
 TRUNCATE = None
 Determines whether to truncate the string to MAXLEN characters.
 
 VALUELIST = None
 Used for enumerated (multiple-choice) attributes. More...
 
 XMLLISTPARAMETER = None
 Used to specify the name of the parameter which contains the enumeration list for XML values. More...
 
 XSDTYPE = None
 Declares the XSD type used when projecting XML Schemas.
 
- Static Public Attributes inherited from DataType
 INDEXNULLMARKER = None
 Override this parameter value to specify what value should be used as a null marker when a property of the type is used in a subscript of an index map. More...
 

Detailed Description

This datatype class validates IP addresses and ports in the format IP|Port.

The IP address can either be an IPV4, IPV6, or DNS name. For example:

127.0.0.1|1972
fe80::20c:29ff:fe21:20cf|1972
hostname|1972

Member Function Documentation

◆ FormatForHttp()

_.Library.String FormatForHttp (   Address)
static

This datatype class validates IP addresses and ports in the format IP|Port.

The IP address can either be an IPV4, IPV6, or DNS name. For example:

127.0.0.1|1972
fe80::20c:29ff:fe21:20cf|1972
hostname|1972

Method to Get the address in a format usable with an http url.

The format of NetworkAddress is address_"|"_port, while the address required for a url is address_":"_port. Furthermore, if the address is an IPV6 colon separated hex representation, the address must be enclosed with [].

◆ IsValid()

_.Library.Status IsValid (   _,
_.Library.RawString  val 
)
static

Tests if the logical value val, which is a string, is valid.

The validation is based on the class parameter settings used for the class attribute this data type is associated with. In this case, MINLEN, MAXLEN, VALUELIST, and PATTERN.

Reimplemented from String.