Interface Project

Method Details

• getConfig

  Config getConfig()

• getRelativeTo

  URI getRelativeTo()

  URI which relative resources should be resolved against.

  Returns:

  URI

• setRelativeTo

  void setRelativeTo(URI relativeTo)

  Set the URI which relative resources should be resolved against.

  Parameters:

  relativeTo - uri to resolve relative resources against.

• getBookmarks

  Bookmarks getBookmarks()

• getFunctionSet

  FunctionSet getFunctionSet()

• getTypeSet

  TypeSet getTypeSet()

• getIdentifiedModels

  IdentifiedCollection<IdentifiedModel> getIdentifiedModels()

• getParameterTemplates

  IdentifiedCollection<UserDefinedParameter> getParameterTemplates()

  Returns:

  any user-defined parameters that can help customize a model for novice users

• getOutputBaseLocation

  URI getOutputBaseLocation()

• setOutputBaseLocation

  void setOutputBaseLocation(URI newOutputBaseLocation)

• validate

  void validate(Consumer<Problem> problemConsumer)

  Validates the project for correctness, passing any error/problems encountered to the problem consumer.

  Parameters:

  problemConsumer - consumer of any encountered problems.

• add

  void add(Bookmark bookmark)

  Convenience for getBookmarks().add(Bookmark)

  Parameters:

  bookmark -

• add

  void add(IdentifiedFunction function)

  Convenience for getFunctionSet().add(IdentifiedFunction)

  Parameters:

  function -

• newBindingContext

  BindingContext newBindingContext()

  Returns:

  a new BindingContext based on the state of the Project

• newBindingContext

  BindingContext newBindingContext(RealizationContext context)

  Parameters:

  context - reuse this realization context in the binding context

• getEngine

  Engine getEngine()

  Returns:

  Engine that should be used to run this project.

• getSridSet

  SRIDSet getSridSet()

  Returns:

  SRIDSet that should be used for this project

• getGeometryValidation

  GeometryValidation getGeometryValidation()

  Returns:

  the default geometry validation mode to apply to bookmarks and other places where geometry validation can be applied

• setGeometryValidation

  void setGeometryValidation(GeometryValidation mode)

• getDefaultCrs

  org.geotools.api.referencing.crs.CoordinateReferenceSystem getDefaultCrs()

  A default CRS to apply to geometry when none is available. Should be used as little as possible, intended for use when constructing relations when a user or data source hasn't specified a CRS.

• newRealizationContext

  RealizationContext newRealizationContext()

  Returns:

  a new context object for Realization.

  ## Implementation Notes

  At the moment, it's possible that a context can be reused for any project, but the intention is that a context would be created and used across the realization and execution of any Pipeline. Eventually this object will be used for resource management, as well as just a convenient way of wrapping up a bunch of related bits

• newExecutionContext

  default ExecutionContext newExecutionContext()

  Returns:

  a new ExecutionContext for this project, constructed via the engine's pipeline executor.

• getTypeBuilder

  TypeBuilder getTypeBuilder()

• getProblemSink

  ProblemSink getProblemSink()

  A place for problems to go. See interface on ProblemSink for usage.