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 TheAllowedValues
method annotation defines the list of valid values for aJobParameter
orRequestParameter
.BusinessApplicationPlugin TheBusinessApplicationPlugin
annotation marks a Java class as a CPF business application plug-in.DefaultValue TheDefaultValue
method annotation defines the default value to display on the form or use if a value was not provided for aJobParameter
orRequestParameter
.GeometryConfiguration TheGeometryConfiguration
annotation can be used on aBusinessApplicationPlugin
class, aRequestParameter
setXXX
method with aGeometry
subclass parameter, or aResultAttribute
getXXX
method with aGeometry
subclass parameter to indicate the configuration of the required coordinate system, precision model, number of coordinate axis and if the geometry should be validated.JobParameter TheJobParameter
method annotation indicates that asetXXX
method is a parameter that will be applied to all requests in a job on aBusinessApplicationPlugin
class.RequestParameter TheRequestParameter
method annotation indicates that asetXXX
method is a structured input data parameter on aBusinessApplicationPlugin
class that has perRequestInputData=false.Required The Required method annotation defines aJobParameter
orRequestParameter
as being required.ResultAttribute TheResultAttribute
method annotation indicates that agetXXX
orisXXX
method is a structured result data attribute on aBusinessApplicationPlugin
orResultList
class that has perRequestResultData=false.ResultList TheResultList
annotation can be used in structured result data plug-ins that return a list of structured results instead of a single result.