io.vertx.tp.atom.modeling.config

Class AoRule

java.lang.Object

io.vertx.tp.atom.modeling.config.AoRule

All Implemented Interfaces:

Serializable

public class AoRule
extends Object
implements Serializable

「Pojo」QRule Definition Object

1. Intro

This object could be mapped to sourceReference field of X_ATTRIBUTE, extracted by rule field.

2. Format

The whole configured json data is as following:

// <pre><code class="json">
    {
        "rule": {
            "conditions": {},
            "condition": {},
            "required": [],
            "diff": []
        }
    }
// </code></pre>

3. Rule Meaning

Each rule is defined as following table.

Rule	Type	Comments
conditions	Input	The criteria condition to fetch data ( Batch ), result is JsonArray.
condition	Input	The criteria condition to fetch data ( Single ), result is JsonObject.
required	Rule	When fetched data source, this rule will check whether each record valid.
unique	Rule	When fetched data source, this rule will compress duplicated records ( pick first ).
diff	Compare	When fetched data array, this rule will combine by fields, compress the duplicated records.

Author:

Lang

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AoRule()

Method Summary

Modifier and Type	Method and Description
io.vertx.core.json.JsonObject	condition(Record record) Build criteria condition based on data record.
io.vertx.core.json.JsonObject	condition(Record[] records) Build criteria condition based on data records.
io.vertx.core.json.JsonObject	getCondition()
io.vertx.core.json.JsonObject	getConditions()
io.vertx.core.json.JsonArray	getDiff()
Set<String>	getRequired()
Set<String>	getUnique()
String	keyDao() Return to daoKey of current item.
void	setCondition(io.vertx.core.json.JsonObject condition)
void	setConditions(io.vertx.core.json.JsonObject conditions)
void	setDiff(io.vertx.core.json.JsonArray diff)
void	setRequired(io.vertx.core.json.JsonArray required)
void	setUnique(io.vertx.core.json.JsonArray unique)
Class<?>	type()
AoRule	type(Class<?> type) 「Fluent」Set the field type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AoRule

public AoRule()

Method Detail

getUnique

public Set<String> getUnique()

Returns:

Set

setUnique

public void setUnique(io.vertx.core.json.JsonArray unique)

Parameters:

unique - JsonArray

getCondition

public io.vertx.core.json.JsonObject getCondition()

Returns:

JsonObject

setCondition

public void setCondition(io.vertx.core.json.JsonObject condition)

Parameters:

condition - JsonObject

getConditions

public io.vertx.core.json.JsonObject getConditions()

Returns:

JsonObject

setConditions

public void setConditions(io.vertx.core.json.JsonObject conditions)

Parameters:

conditions - JsonObject

getRequired

public Set<String> getRequired()

Returns:

Set

setRequired

public void setRequired(io.vertx.core.json.JsonArray required)

Parameters:

required - JsonArray

getDiff

public io.vertx.core.json.JsonArray getDiff()

Returns:

JsonArray

setDiff

public void setDiff(io.vertx.core.json.JsonArray diff)

Parameters:

diff - JsonArray

type

public Class<?> type()

Returns:

Class

type

public AoRule type(Class<?> type)

「Fluent」Set the field type.

Parameters:

type - Class

Returns:

this

keyDao

public String keyDao()

Return to daoKey of current item.

Returns:

String

condition

public io.vertx.core.json.JsonObject condition(Record record)

Build criteria condition based on data record.

Parameters:

record - Record Input data record

Returns:

JsonObject

condition

public io.vertx.core.json.JsonObject condition(Record[] records)

Build criteria condition based on data records.

Parameters:

records - Record[] Input data records.

Returns:

JsonObject