Class ExtraFieldsPostProcessor
- java.lang.Object
-
- org.epics.archiverappliance.retrieval.postprocessors.ExtraFieldsPostProcessor
-
- All Implemented Interfaces:
PostProcessor
public class ExtraFieldsPostProcessor extends Object implements PostProcessor
A post processor that looks for fields- Author:
- mshankar
-
-
Constructor Summary
Constructors Constructor Description ExtraFieldsPostProcessor(String extraFieldName)
-
Method Summary
Modifier and Type Method Description long
estimateMemoryConsumption(String pvName, PVTypeInfo typeInfo, Timestamp start, Timestamp end, javax.servlet.http.HttpServletRequest req)
Estimate the amount of memory required for the data generated by the post processors.String
getExtension()
This is the full form of the identity for the post processor and includes any parameters for the post processor.String
getIdentity()
The string used by clients to identify this post processor when making retrieval requests.void
initialize(String userarg, String pvName)
Initialize this post processor for the given PV and request parameters.Callable<EventStream>
wrap(Callable<EventStream> callable)
Primary data generation method.
-
-
-
Constructor Detail
-
ExtraFieldsPostProcessor
public ExtraFieldsPostProcessor(String extraFieldName)
-
-
Method Detail
-
initialize
public void initialize(String userarg, String pvName) throws IOException
Description copied from interface:PostProcessor
Initialize this post processor for the given PV and request parameters.- Specified by:
initialize
in interfacePostProcessor
- Parameters:
userarg
- This is the full form (extension) of the identity for the post processor.pvName
- The name of PV- Throws:
IOException
-
-
estimateMemoryConsumption
public long estimateMemoryConsumption(String pvName, PVTypeInfo typeInfo, Timestamp start, Timestamp end, javax.servlet.http.HttpServletRequest req)
Description copied from interface:PostProcessor
Estimate the amount of memory required for the data generated by the post processors.- Specified by:
estimateMemoryConsumption
in interfacePostProcessor
- Parameters:
pvName
- The name of PVtypeInfo
- PVTypeInfostart
- Timestampend
- Timestampreq
- HttpServletRequest- Returns:
- Estimated Memory comsumption
-
wrap
public Callable<EventStream> wrap(Callable<EventStream> callable)
Description copied from interface:PostProcessor
Primary data generation method. Using the event stream provided, do your magic and generate processed data- Specified by:
wrap
in interfacePostProcessor
- Parameters:
callable
-- Returns:
- EventStream
-
getIdentity
public String getIdentity()
Description copied from interface:PostProcessor
The string used by clients to identify this post processor when making retrieval requests. For example to identify the FirstSamplePP postprocessor, users would add a pp=firstSample to the request for data. The situation is a little more complex; if a post processor has parameters then it needs to combine these into a string and offer that as an extension. The identity is just the starting part of this.- For example, pp=firstSample_600 asks the server to sparsify with an interval of 600 seconds.
- identity is firstSample.
- extension is firstSample_600.
- User specifies firstSample_600.
- ETL caches the data as firstSample_600 if asked to.
- Specified by:
getIdentity
in interfacePostProcessor
- Returns:
- identify
-
getExtension
public String getExtension()
Description copied from interface:PostProcessor
This is the full form of the identity for the post processor and includes any parameters for the post processor. The exact format and interpretation of this is left to the post processor; however the convention is to use underscores to separate the params and have them in a specific order.- Specified by:
getExtension
in interfacePostProcessor
- Returns:
- extension
- See Also:
PostProcessor.getIdentity()
-
-