Package ca.bc.gov.open.cpf.plugin.api
The Concurrent Processing Framework Java Plug-in API.
-
Class Summary Class Description GeometryFactory The CPF provides an extended version of the Java Topology Suite (JTS) GeometryFactory to create JTS geometries. -
Exception Summary Exception Description RecoverableException A recoverable exception indicates that the cause of the exception can be recovered from. -
Annotation Types Summary Annotation Type Description AllowedValues TheAllowedValuesmethod annotation defines the list of valid values for aJobParameterorRequestParameter.BusinessApplicationPlugin TheBusinessApplicationPluginannotation marks a Java class as a CPF business application plug-in.DefaultValue TheDefaultValuemethod annotation defines the default value to display on the form or use if a value was not provided for aJobParameterorRequestParameter.GeometryConfiguration TheGeometryConfigurationannotation can be used on aBusinessApplicationPluginclass, aRequestParametersetXXXmethod with aGeometrysubclass parameter, or aResultAttributegetXXXmethod with aGeometrysubclass parameter to indicate the configuration of the required coordinate system, precision model, number of coordinate axis and if the geometry should be validated.JobParameter TheJobParametermethod annotation indicates that asetXXXmethod is a parameter that will be applied to all requests in a job on aBusinessApplicationPluginclass.RequestParameter TheRequestParametermethod annotation indicates that asetXXXmethod is a structured input data parameter on aBusinessApplicationPluginclass that has perRequestInputData=false.Required The Required method annotation defines aJobParameterorRequestParameteras being required.ResultAttribute TheResultAttributemethod annotation indicates that agetXXXorisXXXmethod is a structured result data attribute on aBusinessApplicationPluginorResultListclass that has perRequestResultData=false.ResultList TheResultListannotation can be used in structured result data plug-ins that return a list of structured results instead of a single result.