@wider/utils_proto/proto_string/contextParse

Classes

ContextParse

Type Definitions

rowId

the name of a unique row in the dataset - this is regardless of the table in which the row lives. Also used to identify other components in the system such as resource. Format is

Properties:
Name Type Description
tableName NCName

table reference name - often the same as that tag name for the element to which it relates RowId_ // fixed delimiter number // being the nth item that was created - this is not the nth item is the current set of rows as some rows may have been deleted and the remainder are not renumbered [.number] // zero or more numbers, one per required child depth related to instances of a child element. Numbers here restart anew for each of the parent numbers `

Example
contactrowsRowId_2345

wider_context

A ydr context may be considered like a url except that is provides a reference to data, normally to a specific single attribute or its containing element, or to a collection of elements. Contexts are used pervasively to link server side XSD schema and its related data to client side processing.

Just like a url - this is a reference. To use this to actually access the data to which it refers requires the use of code that is authorised to access the data

Contexts can also be extended with hints as to what a application or client browser might do with the reference

Properties:
Name Type Attributes Description
urn objectname <optional>

the unique identifier for the database zone - as used for example in $wider.data.find(urn) to obtain access to a dataset related to the current login. Optional when the id is a system wide unique row id, mandatory otherwise.

id rowId | objectname

a YDR @see rowId or the name of the table that holds the data

attribute objectname <optional>

the name of an attribute in the selected row - if omitted then the context refers to the whole row

xpath xpath <optional>

if present then defines a path from the selected row to the required child element

buttons enum <optional>

possible values |pane|subPane|absent| used only in the schema document to direct the way this attribute or row might be rendered on a form

selector enum <optional>

possible values |table|tableWithAttributesList|tableBase| a suggestion as to which process or report might be related to accessing this context

action enum <optional>

possible values |_edit|_delete|_help| at run time as hints from the client to the server as to what to do next

context string

stays fixed as the value originally used to create this object - to be kept static.

Use .toString() method on this object for the new string context value if anything has changed

target *

deprecated - do not use f