Package ch.tocco.nice2.model.form.api.datanavigation

Interface DataPath

@Deprecated public interface DataPath
Deprecated.
A datapath describes how a chunk of data is reached.

It is abstraction for navigating data in general. So fields, relations, map-key, properties-names etc are represented as a data-path. But also complex stuff like queries and scripts are data paths.

A DataPath describes how to reach the next data-chunk from the current data.

  • Method Details

    • getRawData

      String getRawData()
      Deprecated.
      Get the original content which was in the configuration.

      Examples: 

       Entity:                The "data" attribute of the form tag, for example "Address" for the "Address_detail" form.
 Form field for entity: The "data" attribute of the field tag, so for example the entity field name
                        or relation name like "firstname". Especially in search forms the value can be with
                        relations and end in either a relation or a field, eg "someRel.otherRel.someField".
      Returns:
      string

    • schemaNavigate

      @Nullable @Nullable DataPath.NavigationInfo schemaNavigate(Class<?> schemaType)
      Deprecated.
      This returns info where to navigate to. This navigation is evaluated against a data-schema like a DataModel, Class-Type or XML-Schema.
      If a datapath cannot be evaluated against a schema, (like a script-expression, query etc), this method returns null.
      Parameters:
      schemaType - represent what kind of schema is expected: For example EntityModel.class is used when simple entity-data are expected.
      Returns:
      navigation or null, if this DataPath can only navigate if data are available!

    • useNullDataSource

      boolean useNullDataSource()
      Deprecated.