Icarus Class: Field
The description of a data-field within a library.
  Library data field name, used in definitions and the default for output unless other name(s) are defined.
  Name used on the web interface.
code  Attribute has a default value.
  Code of the token in the 'fields' token list that contains the data-field.
index  Attribute has a default value. show
  Use one of the following values. str link show int real group id date
  Index type. 'show' means that the field can be displayed only; 'group' points to a group of indices (for example, 'AllText'). 'link' is a data field used only to build 'index' links. 'id' is the index for entry IDs. Each library has exactly one such index. 'int' is an integer index, which can be queried with numeric ranges. 'date' is an integer index, which can be queried with numeric ranges. Dates are stored in internal SRS format for easy comparison. 'real' is a real number values index which can be queried with real number ranges. 'str' is the normal index type, searchable with query strings.
  Use one of the following values. y n
  Specifies if a numeric index 'index' is 'int' or 'real'. Contains a range of numbers rather than just one number. This has effects on the query evaluation.
guiInfo GuiField  
  GuiField type to be used. Choose from the names defined for the GuiField class.
  If the data-field is not contained in the 'fields' token list the full name 'tokenList|code' must be specified here.
  Use one of the following values. n y
  Only for fields of subentries: Specifies if a field descends or inherits information from the parent entry.
indexId IdType  
  The ID-type description for the IDs that will be put into the index.
  Only for fields of subentries: Overrules $Libformat.parentToken. The token to be used to display the field within a list view of the parent entry.
  The name of the token list that supplies the values for indexing. The list name may be followed by a token code separated by ':'.
  For XML databanks, the pair [element name, attribute name?] (in case separated by a "&") useful to load the values of a loaded object attribute from an XML entry.
isSystem  Attribute has a default value. 0
  This is a 'system' data field only for internal use and should be ignored by a user interface.
keyConvert  Attribute has a default value. none
  Use one of the following values. none toupper tolower
  Directs case conversion of index strings. 'toupper' forces conversion to upper case. 'tolower' forces conversion to lower case. 'none' preserves the original case.
type SrsField Attribute may stay unnamed in attribute list.Attribute value must be specified.
  Object that describes the data-field type.
replace SrsField  
  Field type of corresponding field object from parent entry in case it is not the same.
parent Field  
  Indicates if the field definition of the parent entry library should be taken instead.
  Name of default format of the contents of a field (see $SrsField).
  Name of the table and the token code.
tableFormat  Attribute has a default value. 0
  Use one of the following values. listing left right center preformat
  The format of the default as displayed inside a 'table view'. May be left unspecified, in which case the same attribute of the 'format' object is read. 'listing' displays a list of values. 'left', 'right' and 'center' are left, right and center justified text respectively. 'preformat' (reserved for future use) displays a preformatted value
sortable  Attribute has a default value. n
  Use one of the following values. n y
  Defines a field to be sortable on. This field name can be passed to the sort method of query and the result set will be sorted.
  The names token tables to use for sorting. If none and field is sortable then use then the indexToken is used. It is also possible to have more than one sorttoken specified for a field. If there is, then the extra tokens need a way of specifying how to search. This is done by treating the list as an associative list of sortTokens, so {firstAuthor "Last Author":lastAuthor} means that there are two ways to sort on the author list - using the firstAuthor token table, or the last author token table.
restrictTo Attribute is multivalued (list). User  
  Restrict access to the users listed.
mergePriority  Attribute has a default value. 1
  This number is used to define the order that indexes will be merged during parallel indexing. Higher numbers are higher priority.
largeIndex  Attribute has a default value. no
  Use one of the following values. n no y yes
  If the index size may be greater than 4 gigabytes then set this to y. 'y' and 'yes' are equivalent. 'n' and 'no' are equivalent.
  Some fields -- particulalrly in Relation Databases but also in XML databases -- contain binary data. If the mimetype of this data is know then we will try and do something sensible with it.
Retrieves the databank name of the field.
Returns a value