Package gov.usgs.earthquake.distribution
Interface ProductCreator
- All Known Implementing Classes:
EQMessageProductCreator
,QuakemlProductCreator
public interface ProductCreator
Interface used by the InputWedge to create products from files.
Parse a file (or directory) into a list of products.
-
Method Summary
Modifier and TypeMethodDescriptiongetProducts
(File file) Parse product(s) from a file or directory.boolean
boolean
boolean
void
setSendMechanismWhenPhasesExist
(boolean sendMechanismWhenPhasesExist) Enable sending mechanism when phases existvoid
setSendOriginWhenPhasesExist
(boolean sendOriginWhenPhasesExist) Enable sending origin when phases existvoid
setValidate
(boolean validate) Enable validation during getProducts method.
-
Method Details
-
getProducts
Parse product(s) from a file or directory.- Parameters:
file
- file or directory.- Returns:
- list of parsed products.
- Throws:
Exception
- if error occurs
-
isValidate
boolean isValidate()- Returns:
- whether product creator is currently validating.
-
setValidate
void setValidate(boolean validate) Enable validation during getProducts method.- Parameters:
validate
- boolean to enable/disable- Throws:
IllegalArgumentException
- if creator doesn't support validation.
-
setSendOriginWhenPhasesExist
void setSendOriginWhenPhasesExist(boolean sendOriginWhenPhasesExist) Enable sending origin when phases exist- Parameters:
sendOriginWhenPhasesExist
- boolean to set
-
isSendOriginWhenPhasesExist
boolean isSendOriginWhenPhasesExist()- Returns:
- whether to send origin when phases exist
-
setSendMechanismWhenPhasesExist
void setSendMechanismWhenPhasesExist(boolean sendMechanismWhenPhasesExist) Enable sending mechanism when phases exist- Parameters:
sendMechanismWhenPhasesExist
- boolean to set
-
isSendMechanismWhenPhasesExist
boolean isSendMechanismWhenPhasesExist()- Returns:
- whether to send mechanism when phases exist
-