Skip to content

Commit

Permalink
merge javadoc and changelog updates
Browse files Browse the repository at this point in the history
  • Loading branch information
bernhardttom2 committed Aug 3, 2017
1 parent fc6d970 commit a84e949
Show file tree
Hide file tree
Showing 21 changed files with 59 additions and 20 deletions.
3 changes: 2 additions & 1 deletion changelog.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Esper Changelog
===================

Changes in version 7.0.0
Changes in version 7.0.0-beta1
------------------------
- Code generation for all interdependent expressions
- The following dependent jar files are upgraded:
Expand All @@ -11,6 +11,7 @@ Changes in version 7.0.0

Minor API Change:
- Event property types are boxed types except when the event type is a Java class and the property type is a primitive type.
Expressions return boxed types.

Changes in version 6.1.0
------------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2333,7 +2333,7 @@ public boolean isEnableExpression() {

/**
* Returns indicator whether to enable code generation for expressions (true by default).
* @return indicator
* @param enableExpression indicator
*/
public void setEnableExpression(boolean enableExpression) {
this.enableExpression = enableExpression;
Expand Down Expand Up @@ -2383,7 +2383,7 @@ public boolean isIncludeComments() {

/**
* Sets indicator whether the generated source code should include comments for tracing back
* @params includeComments
* @param includeComments indicator
*/
public void setIncludeComments(boolean includeComments) {
this.includeComments = includeComments;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ public class CodegenLegoBooleanExpression {
* @param block block
* @param forge forge
* @param context context
* @param checkFor indicator
* @param earlyExitIfNull indicator
* @param resultEarlyExit indicator
* @param resultIfCheckPasses indicator
*/
public static void codegenReturnBoolIfNullOrBool(CodegenBlock block, ExprForge forge, CodegenContext context, boolean earlyExitIfNull, Boolean resultEarlyExit, boolean checkFor, boolean resultIfCheckPasses) {
Class type = forge.getEvaluationType();
Expand Down Expand Up @@ -68,6 +72,7 @@ public static void codegenReturnBoolIfNullOrBool(CodegenBlock block, ExprForge f
* @param block block
* @param forge forge
* @param context context
* @param value value
*/
public static void codegenReturnValueIfNullOrNotPass(CodegenBlock block, ExprForge forge, CodegenContext context, CodegenExpression value) {
codegenDOIfNullOrNotPass(block, forge, context, false, false, true, value);
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<!--
~ **************************************************************************************
~ * Copyright (C) 2006-2015 EsperTech Inc. All rights reserved. *
~ * http://www.espertech.com/esper *
~ * http://www.espertech.com *
~ * ---------------------------------------------------------------------------------- *
~ * The software in this package is published under the terms of the GPL license *
~ * a copy of which has been included with this distribution in the license.txt file. *
~ **************************************************************************************
-->

<html>
<head></head>
<body>
<p>
Code-Generation Method and Method Parameter Model
</p>
</body>
</html>
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ public class InternalEventRouterImpl implements InternalEventRouter {
/**
* Ctor.
* @param engineURI engine URI
* @param engineImportService engine imports
*/
public InternalEventRouterImpl(String engineURI, EngineImportService engineImportService) {
this.engineURI = engineURI;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ public class AggregationServiceFactoryFactory {
* @param numStreams number of streams
* @param measureExprNodesPerStream measure nodes
* @param typesPerStream type information
* @param statementName statement name
* @param engineImportService engine imports
* @return service
* @throws ExprValidationException for validation errors
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ public class BindProcessor {
* @param typesPerStream the event types per stream
* @param streamNames the stream names
* @param tableService table service
* @param engineImportService engine imports
* @param statementName statement name
* @param annotations annotations
* @param isFireAndForget fire-and-forget flag
* @throws ExprValidationException when the validation of the select clause failed
*/
public BindProcessor(SelectClauseElementCompiled[] selectionList,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ public class OrderByProcessorFactoryFactory {
* @param variableService for retrieving variable state for use with row limiting
* @param isSortUsingCollator for string value sorting using compare or Collator
* @param optionalContextName context name
* @param engineImportService engine import svc
* @param onDemandQuery fire-and-forget flag
* @param statementName statement name
* @return ordering processor instance
* @throws com.espertech.esper.epl.expression.core.ExprValidationException when validation of expressions fails
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@ public class OrderByProcessorFactoryImpl implements OrderByProcessorFactory {
* indicates whether this processor needs to have individual
* group by keys to evaluate the sort condition successfully
* @param isSortUsingCollator for string value sorting using compare or Collator
* @param statementName statement name
* @param engineImportService engine imports
* @param onDemandQuery fire-and-forget flag
* @throws com.espertech.esper.epl.expression.core.ExprValidationException when order-by items don't divulge a type
*/
public OrderByProcessorFactoryImpl(final List<OrderByItem> orderByList,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,9 @@ public static CodegenExpression codegen(SelectExprProcessorEnumerationAtBeanColl
* @param result result
* @param eventToPublic conversion
* @param eventsPerStream events
* @param isNewData
* @param exprEvaluatorContext
* @return
* @param isNewData flag
* @param exprEvaluatorContext context
* @return beans
*/
public static EventBean[] convertToTableType(Object result, TableMetadataInternalEventToPublic eventToPublic, EventBean[] eventsPerStream, boolean isNewData, ExprEvaluatorContext exprEvaluatorContext) {
if (result instanceof Collection) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ public static void actionCalendarPlusMinusNumber(Calendar cal, int factor, Long
* @param ldt ldt
* @param factor factor
* @param duration duration
* @return ldt
*/
public static LocalDateTime actionLDTPlusMinusNumber(LocalDateTime ldt, int factor, Long duration) {
if (duration == null) {
Expand All @@ -135,6 +136,7 @@ public static LocalDateTime actionLDTPlusMinusNumber(LocalDateTime ldt, int fact
* @param zdt ldt
* @param factor factor
* @param duration duration
* @return zdt
*/
public static ZonedDateTime actionZDTPlusMinusNumber(ZonedDateTime zdt, int factor, Long duration) {
if (duration == null) {
Expand Down Expand Up @@ -203,6 +205,7 @@ public static void actionCalendarPlusMinusTimePeriod(Calendar cal, int factor, T
* @param ldt ldt
* @param factor factor
* @param tp duration
* @return ldt
*/
public static LocalDateTime actionLDTPlusMinusTimePeriod(LocalDateTime ldt, int factor, TimePeriod tp) {
if (tp == null) {
Expand Down Expand Up @@ -240,6 +243,7 @@ public static LocalDateTime actionLDTPlusMinusTimePeriod(LocalDateTime ldt, int
* @param zdt zdt
* @param factor factor
* @param tp duration
* @return zdt
*/
public static ZonedDateTime actionZDTPlusMinusTimePeriod(ZonedDateTime zdt, int factor, TimePeriod tp) {
if (tp == null) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,6 @@ public static CodegenExpression codegenZDT(CalendarWithTimeForge forge, CodegenE
* @param minute min
* @param second sec
* @param msec msec
* @return ldt
*/
public static void actionSetHMSMCalendar(Calendar cal, Integer hour, Integer minute, Integer second, Integer msec) {
if (hour != null) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@ public Boolean compute(long leftStart, long leftEnd, long rightStart, long right
* @param right right
* @param start start
* @param end end
* @returnflag
* @return flag
*/
public static boolean computeIntervalBefore(long leftEnd, long right, long start, long end) {
long delta = right - leftEnd;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ public static CodegenExpression codegen(EnumOrderByAscDescEventsForge forge, Cod
* @param sort sorted
* @param hasColl collection flag
* @param descending true for descending
* @return
* @return collection
*/
public static Collection enumOrderBySortEval(TreeMap<Comparable, Object> sort, boolean hasColl, boolean descending) {
Map<Comparable, Object> sorted;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -149,9 +149,11 @@ public StatementSpecCompiled getStatementSpecCompiled() {
}

/**
* Sets the validate select clause
* Sets the validates select clause
*
* @param selectClause is the expression representing the select clause
* @param engineImportService engine import service
* @param statementName name
*/
public void setSelectClause(ExprNode[] selectClause, EngineImportService engineImportService, String statementName) {
this.selectClause = selectClause;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ public class NStreamOuterQueryPlanBuilder {
* @param historicalViewableDesc historicals
* @param indexedStreamsUniqueProps unique props
* @param tablesPerStream tables
* @param isFireAndForget fire-and-forget flag
* @param engineImportService engine imports
* @return query plan
* @throws ExprValidationException if the query planning failed
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ public class QueryPlanBuilder {
* @param isQueryPlanLogging for logging
* @param exprEvaluatorContext context
* @param annotations annotations
* @param isFireAndForget fire-and-forget flag
* @param engineImportService engine imports
* @return query plan
* @throws ExprValidationException if the query plan fails
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ public class VariableReadWritePackage {
* @param assignments the list of variable assignments
* @param variableService variable service
* @param eventAdapterService event adapters
* @param statementName statement name
* @throws com.espertech.esper.epl.expression.core.ExprValidationException when variables cannot be found
*/
public VariableReadWritePackage(List<OnTriggerSetAssignment> assignments, VariableService variableService, EventAdapterService eventAdapterService, String statementName)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,6 @@ public class ObjectArrayEventBeanPropertyGetter implements ObjectArrayEventPrope
private final int propertyIndex;
private final Class underlyingType;

/**
* Ctor.
*
* @param propertyIndex property to get
*/
public ObjectArrayEventBeanPropertyGetter(int propertyIndex, Class underlyingType) {
this.propertyIndex = propertyIndex;
this.underlyingType = underlyingType;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ public static Object makeUnderlyingFromFastCtor(Object[] properties, FastConstru
* NOTE: Code-generation-invoked method, method name and parameter order matters
* @param targetClassName name
* @param targetException ex
* @return exception
*/
public static EPException getTargetExceptionAsEPException(String targetClassName, Throwable targetException) {
return new EPException("InvocationTargetException received invoking constructor for type '" + targetClassName + "': " + targetException.getMessage(), targetException);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,6 @@ public class MapEventBeanPropertyGetter implements MapEventPropertyGetter {
private final String propertyName;
private final Class underlyingType;

/**
* Ctor.
*
* @param propertyName property to get
*/
public MapEventBeanPropertyGetter(String propertyName, Class underlyingType) {
this.propertyName = propertyName;
this.underlyingType = underlyingType;
Expand Down

0 comments on commit a84e949

Please sign in to comment.