io.vertx.tp.ke.atom.metadata

Class KField

java.lang.Object

io.vertx.tp.ke.atom.metadata.KField

All Implemented Interfaces:

Serializable

public class KField
extends Object
implements Serializable

「Pojo」Critical Fields

1. Intro

Here this class defined critical data structure to store field specification.

2. Data Format

// <pre><code class="json">
    {
        "key": "",
        "numbers": {
             "fields": "numberCode1"
        },
        "unique": [
             [
                 "field1",
                 "field2"
             ]
        ],
        "created": {
            "by": "",
            "at": ""
        },
        "updated": {
            "by": "",
            "at": ""
        }
    }
// </code></pre>

3. Comments

All the fields have been stored in field of configuration json.

Json	Comment
key	The primary key field name（One field support only）.
unique	The business unique rule of multi fields（Business Unique).
numbers	The numbers field that is related to X_NUMBER.
created.by	The created user id of auditor.
created.at	The created timestamp of audition.
updated.by	The updated user id of auditor.
updated.at	The updated timestamp of audition.

4. Design

1. The design of zero extension module support single field primary key only, it could be defined key, it’s proxy primary key instead of complex mode ( More than one primary key field ).
2. You can provide more than one UNIQUE rule, it means that if you have primary key of multi fields defined, you can provide business rule instead of it.
3. For auditor feature, here are standard four fields: createdAt, createdBy, updatedAt, updatedBy.

Author:

Lang

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
KField()

Method Summary

Modifier and Type	Method and Description
Set<String>	fieldArray()
Set<String>	fieldObject()
io.vertx.core.json.JsonArray	getArray()
io.vertx.core.json.JsonObject	getCreated()
String	getKey()
io.vertx.core.json.JsonObject	getNumbers()
io.vertx.core.json.JsonArray	getObject()
io.vertx.core.json.JsonArray	getUnique()
io.vertx.core.json.JsonObject	getUpdated()
void	setArray(io.vertx.core.json.JsonArray array)
void	setCreated(io.vertx.core.json.JsonObject created)
void	setKey(String key)
void	setNumbers(io.vertx.core.json.JsonObject numbers)
void	setObject(io.vertx.core.json.JsonArray object)
void	setUnique(io.vertx.core.json.JsonArray unique)
void	setUpdated(io.vertx.core.json.JsonObject updated)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

KField

public KField()

Method Detail

getKey

public String getKey()

setKey

public void setKey(String key)

getUnique

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

setUnique

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

getCreated

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

setCreated

public void setCreated(io.vertx.core.json.JsonObject created)

getUpdated

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

setUpdated

public void setUpdated(io.vertx.core.json.JsonObject updated)

getNumbers

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

setNumbers

public void setNumbers(io.vertx.core.json.JsonObject numbers)

getObject

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

setObject

public void setObject(io.vertx.core.json.JsonArray object)

getArray

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

setArray

public void setArray(io.vertx.core.json.JsonArray array)

fieldArray

public Set<String> fieldArray()

fieldObject

public Set<String> fieldObject()

toString

public String toString()

Overrides:

toString in class Object