org.nuiton.wikitty
Interface Wikitty

All Superinterfaces:

java.lang.Cloneable, java.io.Serializable

All Known Implementing Classes:

WikittyCopyOnWrite, WikittyImpl

public interface Wikitty
extends java.lang.Cloneable, java.io.Serializable

Method Summary

void	addExtension(java.util.List<WikittyExtension> exts)
void	addExtension(WikittyExtension ext)
void	addMetaExtension(WikittyExtension metaExtension, java.lang.String extensionFqn) add a meta-extension on the given extension to this wikitty.
void	addMetaExtension(WikittyExtension metaExtension, WikittyExtension extension) add a meta-extension about the given extension to this wikitty.
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener)
void	addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
void	addToField(java.lang.String fqFieldName, java.lang.Object value) Add an element in a field
void	addToField(java.lang.String ext, java.lang.String fieldName, java.lang.Object value)
void	clearDirty() clear the lists of modified field since last restore.
void	clearField(java.lang.String fqFieldName) Clear a field
void	clearField(java.lang.String ext, java.lang.String fieldName)
Wikitty	clone()
java.util.Set<java.lang.String>	fieldNames()
java.util.Date	getDeleteDate()
java.util.Set<java.lang.String>	getDirty() get the field modified after wikitty was restored
WikittyExtension	getExtension(java.lang.String ext)
java.util.Collection<WikittyExtension>	getExtensionDependencies(java.lang.String ext, boolean recursively)
java.util.Collection<java.lang.String>	getExtensionNames()
java.util.Collection<WikittyExtension>	getExtensions()
java.math.BigDecimal	getFieldAsBigDecimal(java.lang.String ext, java.lang.String fieldName)
boolean	getFieldAsBoolean(java.lang.String ext, java.lang.String fieldName)
java.util.Date	getFieldAsDate(java.lang.String ext, java.lang.String fieldName)
double	getFieldAsDouble(java.lang.String ext, java.lang.String fieldName)
float	getFieldAsFloat(java.lang.String ext, java.lang.String fieldName)
int	getFieldAsInt(java.lang.String ext, java.lang.String fieldName)
<E> java.util.List<E>	getFieldAsList(java.lang.String ext, java.lang.String fieldName, java.lang.Class<E> clazz) If object is a set, it is automatically transform to list.
long	getFieldAsLong(java.lang.String ext, java.lang.String fieldName)
java.lang.Object	getFieldAsObject(java.lang.String ext, java.lang.String fieldName)
<E> java.util.Set<E>	getFieldAsSet(java.lang.String ext, java.lang.String fieldName, java.lang.Class<E> clazz)
java.lang.String	getFieldAsString(java.lang.String ext, java.lang.String fieldName)
java.lang.String	getFieldAsWikitty(java.lang.String ext, java.lang.String fieldName) return wikitty id and not wikitty objet because this method can be call on server or client side and it's better to keep conversion between id and objet to the caller
FieldType	getFieldType(java.lang.String fqfieldName) return field type for the given fieldName.
java.lang.Object	getFqField(java.lang.String fqFieldName) get the value of and field given its fqn
java.lang.String	getId()
java.lang.String	getVersion()
boolean	hasExtension(java.lang.String extName)
boolean	hasField(java.lang.String extName, java.lang.String fieldName)
boolean	hasMetaExtension(java.lang.String metaExtensionName, java.lang.String extensionName) check that the wikitty has a metaExtension about a given extension.
boolean	isDeleted()
boolean	isEmpty()
void	removeFromField(java.lang.String fqFieldName, java.lang.Object value) Remove an element from a field
void	removeFromField(java.lang.String ext, java.lang.String fieldName, java.lang.Object value)
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener)
void	removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
void	setDeleteDate(java.util.Date delete) Server only used
void	setField(java.lang.String ext, java.lang.String fieldName, java.lang.Object value)
void	setFqField(java.lang.String fieldName, java.lang.Object value) set the value of a field given is fqn.
void	setVersion(java.lang.String version) Server only used

Method Detail

addPropertyChangeListener

void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

removePropertyChangeListener

void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

addPropertyChangeListener

void addPropertyChangeListener(java.lang.String propertyName,
                               java.beans.PropertyChangeListener listener)

removePropertyChangeListener

void removePropertyChangeListener(java.lang.String propertyName,
                                  java.beans.PropertyChangeListener listener)

getId

java.lang.String getId()

isDeleted

boolean isDeleted()

getDeleteDate

java.util.Date getDeleteDate()

setDeleteDate

void setDeleteDate(java.util.Date delete)

Server only used

Parameters:

delete -

addExtension

void addExtension(WikittyExtension ext)

addExtension

void addExtension(java.util.List<WikittyExtension> exts)

hasMetaExtension

boolean hasMetaExtension(java.lang.String metaExtensionName,
                         java.lang.String extensionName)

check that the wikitty has a metaExtension about a given extension.

Parameters:

metaExtensionName - the metaExtension to be checked

extensionName - an extension already added to the wikitty

Since:

2.2.0

addMetaExtension

void addMetaExtension(WikittyExtension metaExtension,
                      WikittyExtension extension)

add a meta-extension about the given extension to this wikitty.

Parameters:

metaExtension - the metaExtension to add

extension - an extension already added to the wikitty

Since:

2.1

addMetaExtension

void addMetaExtension(WikittyExtension metaExtension,
                      java.lang.String extensionFqn)

add a meta-extension on the given extension to this wikitty.

Parameters:

metaExtension - the metaExtension to add

extensionFqn - the name of the extension already added to the wikitty

Since:

2.1

hasExtension

boolean hasExtension(java.lang.String extName)

hasField

boolean hasField(java.lang.String extName,
                 java.lang.String fieldName)

getExtension

WikittyExtension getExtension(java.lang.String ext)

getExtensionNames

java.util.Collection<java.lang.String> getExtensionNames()

getExtensions

java.util.Collection<WikittyExtension> getExtensions()

getExtensionDependencies

java.util.Collection<WikittyExtension> getExtensionDependencies(java.lang.String ext,
                                                                boolean recursively)

getFieldType

FieldType getFieldType(java.lang.String fqfieldName)

return field type for the given fieldName.

Parameters:

fqfieldName - fully qualified fieldName extension.fieldname

Returns:

field type

setField

void setField(java.lang.String ext,
              java.lang.String fieldName,
              java.lang.Object value)

getFieldAsObject

java.lang.Object getFieldAsObject(java.lang.String ext,
                                  java.lang.String fieldName)

getFieldAsBoolean

boolean getFieldAsBoolean(java.lang.String ext,
                          java.lang.String fieldName)

getFieldAsBigDecimal

java.math.BigDecimal getFieldAsBigDecimal(java.lang.String ext,
                                          java.lang.String fieldName)

getFieldAsInt

int getFieldAsInt(java.lang.String ext,
                  java.lang.String fieldName)

getFieldAsLong

long getFieldAsLong(java.lang.String ext,
                    java.lang.String fieldName)

getFieldAsFloat

float getFieldAsFloat(java.lang.String ext,
                      java.lang.String fieldName)

getFieldAsDouble

double getFieldAsDouble(java.lang.String ext,
                        java.lang.String fieldName)

getFieldAsString

java.lang.String getFieldAsString(java.lang.String ext,
                                  java.lang.String fieldName)

getFieldAsDate

java.util.Date getFieldAsDate(java.lang.String ext,
                              java.lang.String fieldName)

getFieldAsWikitty

java.lang.String getFieldAsWikitty(java.lang.String ext,
                                   java.lang.String fieldName)

return wikitty id and not wikitty objet because this method can be call on server or client side and it's better to keep conversion between id and objet to the caller

Parameters:

ext - extension name where this field must to be

fieldName - the field name

Returns:

id of wikitty object or null

Throws:

WikittyException

getFieldAsList

<E> java.util.List<E> getFieldAsList(java.lang.String ext,
                                     java.lang.String fieldName,
                                     java.lang.Class<E> clazz)

If object is a set, it is automatically transform to list.

Type Parameters:

E -

Parameters:

clazz -

Returns:

unmodifiable list

getFieldAsSet

<E> java.util.Set<E> getFieldAsSet(java.lang.String ext,
                                   java.lang.String fieldName,
                                   java.lang.Class<E> clazz)

Type Parameters:

E -

Parameters:

clazz -

Returns:

unmodifiable list

addToField

void addToField(java.lang.String ext,
                java.lang.String fieldName,
                java.lang.Object value)

removeFromField

void removeFromField(java.lang.String ext,
                     java.lang.String fieldName,
                     java.lang.Object value)

clearField

void clearField(java.lang.String ext,
                java.lang.String fieldName)

addToField

void addToField(java.lang.String fqFieldName,
                java.lang.Object value)

Add an element in a field

Parameters:

fqFieldName - the fully qualified name of a collection field

value - the value to be added to the collection

Since:

2.2.0

removeFromField

void removeFromField(java.lang.String fqFieldName,
                     java.lang.Object value)

Remove an element from a field

Parameters:

fqFieldName - the fully qualified name of a collection field

value - the value to be removed to the collection

Since:

2.2.0

clearField

void clearField(java.lang.String fqFieldName)

Clear a field

Parameters:

fqFieldName - the fully qualified name of a collection field

Since:

2.2.0

fieldNames

java.util.Set<java.lang.String> fieldNames()

getFqField

java.lang.Object getFqField(java.lang.String fqFieldName)

get the value of and field given its fqn

getVersion

java.lang.String getVersion()

setVersion

void setVersion(java.lang.String version)

Server only used

Parameters:

version -

getDirty

java.util.Set<java.lang.String> getDirty()

get the field modified after wikitty was restored

Returns:

a set of fully qualified field names

Since:

2.2.0

clearDirty

void clearDirty()

clear the lists of modified field since last restore.

setFqField

void setFqField(java.lang.String fieldName,
                java.lang.Object value)

set the value of a field given is fqn.

Parameters:

fieldName - fqn (ex: extensionName.fieldName)

value - new value

isEmpty

boolean isEmpty()

clone

Wikitty clone()
              throws java.lang.CloneNotSupportedException

Throws:

java.lang.CloneNotSupportedException

See Also:

Cloneable#clone()