Wikitty (Wikitty :: api 3.8 API)

All Superinterfaces:

Cloneable, Serializable

All Known Implementing Classes:

WikittyCopyOnWrite, WikittyImpl
```
public interface Wikitty
extends Cloneable, Serializable
```
Wikitty object, containing data as map.

Version:

$Revision: 1494 $ Last update : $Date: 2012-08-07 16:01:14 +0200 (mar. 07 août 2012) $ By : $Author: bpoussin $

Author:

chatellier

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addExtension(Collection<WikittyExtension> exts)` Add multiples extensions.
`void`	`addExtension(WikittyExtension ext)` Add new extension.
`void`	`addMetaExtension(WikittyExtension metaExtension, 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`	`addPreloaded(Wikitty w)` Ajoute un wikitty comme preloaded dans la liste des wikitties prechargee.
`void`	`addPropertyChangeListener(PropertyChangeListener listener)` Add property change listener.
`void`	`addPropertyChangeListener(String propertyName, PropertyChangeListener listener)` Add property change listener on property.
`void`	`addToField(String fqFieldName, Object value)` Add an element in a field
`void`	`addToField(String ext, String fieldName, Object value)`
`void`	`clearDirty()` clear the lists of modified field since last restore.
`void`	`clearField(String fqFieldName)` Clear a field
`void`	`clearField(String ext, String fieldName)`
`Wikitty`	`clone()`
`Set<String>`	`fieldNames()` Return only used fieldNames
`Set<String>`	`getAllFieldNames()` Return all fieldName available in all extension.
`Set<String>`	`getAllPreloadPattern()` Retourne tous les patterns de preload, celui demande lors du restore et tout ceux defini par le tag value 'preload' sur les extensions.
`Date`	`getDeleteDate()` Return deletion date.
`Set<String>`	`getDirty()` get the field modified after wikitty was restored
`WikittyExtension`	`getExtension(String ext)`
`Collection<WikittyExtension>`	`getExtensionDependencies(String ext, boolean recursively)` Recherche toutes les extensions de ce wikitty qui dependent d'une extension particuliere
`Collection<String>`	`getExtensionFields(String ext)` Retourne tous les noms de champs pour un nom d'extension donne.
`Collection<String>`	`getExtensionNames()`
`Collection<WikittyExtension>`	`getExtensions()`
`BigDecimal`	`getFieldAsBigDecimal(String ext, String fieldName)`
`boolean`	`getFieldAsBoolean(String ext, String fieldName)`
`byte[]`	`getFieldAsBytes(String ext, String fieldName)`
`Date`	`getFieldAsDate(String ext, String fieldName)`
`double`	`getFieldAsDouble(String ext, String fieldName)`
`float`	`getFieldAsFloat(String ext, String fieldName)`
`int`	`getFieldAsInt(String ext, String fieldName)`
`<E> List<E>`	`getFieldAsList(String ext, String fieldName, Class<E> clazz)` If object is a set, it is automatically transform to list.
`long`	`getFieldAsLong(String ext, String fieldName)`
`Object`	`getFieldAsObject(String ext, String fieldName)` Get field value. if fieldName doesn't exists on this extension an exception is throw
`<E> Set<E>`	`getFieldAsSet(String ext, String fieldName, Class<E> clazz)`
`String`	`getFieldAsString(String ext, String fieldName)`
`String`	`getFieldAsWikitty(String ext, 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
`Wikitty`	`getFieldAsWikitty(String extName, String fieldName, boolean exceptionIfNotLoaded)` return Wikitty for field only if this wikitty is preloaded, null or exception otherwize.
`List<Wikitty>`	`getFieldAsWikittyList(String ext, String fieldName, boolean exceptionIfNotLoaded)`
`Set<Wikitty>`	`getFieldAsWikittySet(String ext, String fieldName, boolean exceptionIfNotLoaded)`
`FieldType`	`getFieldType(String fqfieldName)` Return field type for the given fieldName.
`FieldType`	`getFieldType(String extName, String fieldName)` Return field type for the given fieldName.
`Map<String,Object>`	`getFieldValue()` All field value in unmodifiable map
`Object`	`getFqField(String fqFieldName)` get the value of and field given its fqn, if this field doesn't exists null is returned
`String`	`getId()` Deprecated. use getWikittyIdNNN
`Map<String,Wikitty>`	`getPreloaded()` Retourne la map des wikitties precharges, si aucun objet n'est precharge alors retourne une map vide.
`String`	`getPreloadPattern()` Retourne le pattern de preload demande lors du restore ou null si aucun preload n'a ete demande.
`String`	`getVersion()` Deprecated. use getWikittyVersionNNN
`String`	`getWikittyId()` Get wikkity id.
`String`	`getWikittyVersion()` Return wikitty version (x.y).
`boolean`	`hasExtension(String extName)` Check if current wikitty has extension.
`boolean`	`hasField(String fqfieldName)` Check if current wikitty has requested fully qualified field.
`boolean`	`hasField(String extName, String fieldName)` Check if current wikitty has requested field.
`boolean`	`hasMetaExtension(String metaExtensionName, String extensionName)` Check that the wikitty has a metaExtension about a given extension.
`boolean`	`isDeleted()` Return `true` is wikitty is deleted.
`boolean`	`isEmpty()`
`void`	`removeFromField(String fqFieldName, Object value)` Remove an element from a field
`void`	`removeFromField(String ext, String fieldName, Object value)`
`void`	`removePropertyChangeListener(PropertyChangeListener listener)` Remove property change listener.
`void`	`removePropertyChangeListener(String propertyName, PropertyChangeListener listener)` Remove property change listener on property.
`void`	`replaceWith(Wikitty w)` Replace all field of current wikitty with field found in w.
`void`	`replaceWith(Wikitty w, boolean force)` Replace all field of current wikitty with field found in w.
`void`	`setDeleteDate(Date date)` Set deletion date.
`void`	`setField(String ext, String fieldName, Object value)` Set field value.
`void`	`setFqField(String fieldName, Object value)` set the value of a field given is fqn.
`void`	`setPreloaded(Map<String,Wikitty> preloaded)` Modifie la liste des wikitties prechargee
`void`	`setPreloadPattern(String preloadPattern)` Modifie le pattern de preload
`void`	`setVersion(String version)` Deprecated. use setWikittyVersionNNN
`void`	`setWikittyVersion(String version)` Server only used
`String`	`toString(String extName)` Return String representation of this wikitty with toString specific format of extension passed in argument.
`String`	`toStringAllField()` Print all field of all extension

- Method Detail
  - addPropertyChangeListener
```
void addPropertyChangeListener(PropertyChangeListener listener)
```
    Add property change listener.
    
    Parameters:
    listener - listener to add
  - removePropertyChangeListener
```
void removePropertyChangeListener(PropertyChangeListener listener)
```
    Remove property change listener.
    
    Parameters:
    listener - listener to remove
  - addPropertyChangeListener
```
void addPropertyChangeListener(String propertyName,
                             PropertyChangeListener listener)
```
    Add property change listener on property.
    
    Parameters:
    propertyName - property to listen
    listener - listener to add
  - removePropertyChangeListener
```
void removePropertyChangeListener(String propertyName,
                                PropertyChangeListener listener)
```
    Remove property change listener on property.
    
    Parameters:
    propertyName - property to listen
    listener - listener to remove
  - getPreloadPattern
```
String getPreloadPattern()
```
    Retourne le pattern de preload demande lors du restore ou null si aucun preload n'a ete demande.
    
    Returns:
  - setPreloadPattern
```
void setPreloadPattern(String preloadPattern)
```
    Modifie le pattern de preload
    
    Parameters:
    preloadPattern - un nouveau pattern ou null
  - getAllPreloadPattern
```
Set<String> getAllPreloadPattern()
```
    Retourne tous les patterns de preload, celui demande lors du restore et tout ceux defini par le tag value 'preload' sur les extensions. La Collection contient une liste de chaine qui n'ont comme separateur que des ','. Car chaque separateur ';' donne une entre differente dans la collection.
    
    Returns:
    Collection with pattern or empty collection if no pattern
  - getPreloaded
```
Map<String,Wikitty> getPreloaded()
```
    Retourne la map des wikitties precharges, si aucun objet n'est precharge alors retourne une map vide. La collection retournee est non modifiable.
    
    Returns:
    Retourne toujours une map au pire elle est vide
  - setPreloaded
```
void setPreloaded(Map<String,Wikitty> preloaded)
```
    Modifie la liste des wikitties prechargee
    
    Parameters:
    preloaded -
  - addPreloaded
```
void addPreloaded(Wikitty w)
```
    Ajoute un wikitty comme preloaded dans la liste des wikitties prechargee.
    
    Parameters:
    w - le wikitty a ajouter
  - replaceWith
```
void replaceWith(Wikitty w)
```
    Replace all field of current wikitty with field found in w. This two wikitty must have same id.
    
    Parameters:
    w - wikitty where we take information
  - replaceWith
```
void replaceWith(Wikitty w,
               boolean force)
```
    Replace all field of current wikitty with field found in w. This two wikitty must have same id if force is false
    
    Parameters:
    w - wikitty where we take information
    force -
  - getId
```
@Deprecated
String getId()
```
    Deprecated. use getWikittyIdNNN
    
    Get wikkity id.
    
    Returns:
    wikytty id
  - getWikittyId
```
String getWikittyId()
```
    Get wikkity id.
    
    Returns:
    wikytty id
    Since:
    
    3.8
  - isDeleted
```
boolean isDeleted()
```
    Return true is wikitty is deleted.
    
    Returns:
    true is wikitty is deleted
  - getDeleteDate
```
Date getDeleteDate()
```
    Return deletion date.
    
    Returns:
    deletion date or null if not deleted
  - setDeleteDate
```
void setDeleteDate(Date date)
```
    Set deletion date. Server only used.
    
    Parameters:
    date - deletion date
  - addExtension
```
void addExtension(WikittyExtension ext)
```
    Add new extension.
    
    Parameters:
    ext - extension to add
  - addExtension
```
void addExtension(Collection<WikittyExtension> exts)
```
    Add multiples extensions.
    
    Parameters:
    exts - extensions to add
  - hasMetaExtension
```
boolean hasMetaExtension(String metaExtensionName,
                       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
    
    Returns:
    true if current wikitty has meta extension
    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,
                    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(String extName)
```
    Check if current wikitty has extension.
    
    Parameters:
    extName - extension name to check
    
    Returns:
    true if current wikitty has extension.
  - hasField
```
boolean hasField(String extName,
               String fieldName)
```
    Check if current wikitty has requested field.
    
    Parameters:
    extName - extension name
    fieldName - field name on extension
    
    Returns:
    true if wikitty has field
  - hasField
```
boolean hasField(String fqfieldName)
```
    Check if current wikitty has requested fully qualified field.
    
    Parameters:
    fqfieldName - fully qualified field name
    
    Returns:
    true if wikitty has field
  - getExtension
```
WikittyExtension getExtension(String ext)
```
  - getExtensionNames
```
Collection<String> getExtensionNames()
```
  - getExtensions
```
Collection<WikittyExtension> getExtensions()
```
  - getExtensionFields
```
Collection<String> getExtensionFields(String ext)
```
    Retourne tous les noms de champs pour un nom d'extension donne.
    
    Parameters:
    ext - le nom de l'extension
    
    Returns:
    la liste des noms de champs
    Since:
    
    3.8
  - getExtensionDependencies
```
Collection<WikittyExtension> getExtensionDependencies(String ext,
                                                    boolean recursively)
```
    Recherche toutes les extensions de ce wikitty qui dependent d'une extension particuliere
    
    Parameters:
    ext - le nom d'une extension
    recursively - si la dependance doit aussi etre recherche recursivement
    
    Returns:
    la liste des extensions de ce Wikitty qui depande de l'extension dont le nom est passé en parametre (de facon direct ou indirect)
  - getFieldType
```
FieldType getFieldType(String fqfieldName)
```
    Return field type for the given fieldName.
    
    Parameters:
    fqfieldName - fully qualified fieldName extension.fieldname
    
    Returns:
    field type
  - getFieldType
```
FieldType getFieldType(String extName,
                     String fieldName)
```
    Return field type for the given fieldName.
    
    Parameters:
    extName - extension name
    fieldName - field name
    
    Returns:
    field type
  - setField
```
void setField(String ext,
            String fieldName,
            Object value)
```
    Set field value.
    
    Parameters:
    ext - extension
    fieldName - field name
    value -
  - getFieldAsObject
```
Object getFieldAsObject(String ext,
                      String fieldName)
```
    Get field value. if fieldName doesn't exists on this extension an exception is throw
    
    Parameters:
    ext - extension name
    fieldName - field name
    
    Returns:
  - getFieldAsBytes
```
byte[] getFieldAsBytes(String ext,
                     String fieldName)
```
  - getFieldAsBoolean
```
boolean getFieldAsBoolean(String ext,
                        String fieldName)
```
  - getFieldAsBigDecimal
```
BigDecimal getFieldAsBigDecimal(String ext,
                              String fieldName)
```
  - getFieldAsInt
```
int getFieldAsInt(String ext,
                String fieldName)
```
  - getFieldAsLong
```
long getFieldAsLong(String ext,
                  String fieldName)
```
  - getFieldAsFloat
```
float getFieldAsFloat(String ext,
                    String fieldName)
```
  - getFieldAsDouble
```
double getFieldAsDouble(String ext,
                      String fieldName)
```
  - getFieldAsString
```
String getFieldAsString(String ext,
                      String fieldName)
```
  - getFieldAsDate
```
Date getFieldAsDate(String ext,
                  String fieldName)
```
  - getFieldAsWikitty
```
String getFieldAsWikitty(String ext,
                       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
  - getFieldAsWikitty
```
Wikitty getFieldAsWikitty(String extName,
                        String fieldName,
                        boolean exceptionIfNotLoaded)
```
    return Wikitty for field only if this wikitty is preloaded, null or exception otherwize.
    
    Parameters:
    extName - extension name where this field must to be
    fieldName - the field name
    exceptionIfNotLoaded - if true and this field is not preloaded an exception is throw, otherwize null is returned. But if field is null (never set or set to null) and exceptionIfNotLoaded is true. This method must return null and not throw exception.
    
    Returns:
    Wikitty object or null
  - getFieldAsList
```
<E> List<E> getFieldAsList(String ext,
                         String fieldName,
                         Class<E> clazz)
```
    If object is a set, it is automatically transform to list.
    
    Type Parameters:
    E -
    Parameters:
    clazz -
    
    Returns:
    unmodifiable list
  - getFieldAsWikittyList
```
List<Wikitty> getFieldAsWikittyList(String ext,
                                  String fieldName,
                                  boolean exceptionIfNotLoaded)
```
  - getFieldAsSet
```
<E> Set<E> getFieldAsSet(String ext,
                       String fieldName,
                       Class<E> clazz)
```
    Type Parameters:
    E -
    Parameters:
    clazz -
    
    Returns:
    unmodifiable list
  - getFieldAsWikittySet
```
Set<Wikitty> getFieldAsWikittySet(String ext,
                                String fieldName,
                                boolean exceptionIfNotLoaded)
```
  - addToField
```
void addToField(String ext,
              String fieldName,
              Object value)
```
  - removeFromField
```
void removeFromField(String ext,
                   String fieldName,
                   Object value)
```
  - clearField
```
void clearField(String ext,
              String fieldName)
```
  - addToField
```
void addToField(String fqFieldName,
              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(String fqFieldName,
                   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(String fqFieldName)
```
    Clear a field
    
    Parameters:
    fqFieldName - the fully qualified name of a collection field
    Since:
    
    2.2.0
  - fieldNames
```
Set<String> fieldNames()
```
    Return only used fieldNames
    
    Returns:
  - getFieldValue
```
Map<String,Object> getFieldValue()
```
    All field value in unmodifiable map
    
    Returns:
  - getAllFieldNames
```
Set<String> getAllFieldNames()
```
    Return all fieldName available in all extension. Field is fq.
    
    Returns:
    Since:
    
    3.1
  - getFqField
```
Object getFqField(String fqFieldName)
```
    get the value of and field given its fqn, if this field doesn't exists null is returned
    
    Parameters:
    fqFieldName -
    
    Returns:
  - getVersion
```
@Deprecated
String getVersion()
```
    Deprecated. use getWikittyVersionNNN
  - getWikittyVersion
```
String getWikittyVersion()
```
    Return wikitty version (x.y).
    
    Returns:
    wikitty version
    Since:
    
    3.8
  - setVersion
```
@Deprecated
void setVersion(String version)
```
    Deprecated. use setWikittyVersionNNN
    
    Server only used
    
    Parameters:
    version -
  - setWikittyVersion
```
void setWikittyVersion(String version)
```
    Server only used
    
    Parameters:
    version -
    Since:
    
    3.8
  - getDirty
```
Set<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(String fieldName,
              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 CloneNotSupportedException
```
    Throws:
    
    CloneNotSupportedException
    See Also:
    Object.clone()
  - toString
```
String toString(String extName)
```
    Return String representation of this wikitty with toString specific format of extension passed in argument. If this extension doesn't have specifique toString, normal toString is called #toString()
  - toStringAllField
```
String toStringAllField()
```
    Print all field of all extension

Interface Wikitty

Method Summary

Method Detail

addPropertyChangeListener

removePropertyChangeListener

addPropertyChangeListener

removePropertyChangeListener

getPreloadPattern

setPreloadPattern

getAllPreloadPattern

getPreloaded

setPreloaded

addPreloaded

replaceWith

replaceWith

getId

getWikittyId

isDeleted

getDeleteDate

setDeleteDate

addExtension

addExtension

hasMetaExtension

addMetaExtension

addMetaExtension

hasExtension

hasField

hasField

getExtension

getExtensionNames

getExtensions

getExtensionFields

getExtensionDependencies

getFieldType

getFieldType

setField

getFieldAsObject

getFieldAsBytes

getFieldAsBoolean

getFieldAsBigDecimal

getFieldAsInt

getFieldAsLong

getFieldAsFloat

getFieldAsDouble

getFieldAsString

getFieldAsDate

getFieldAsWikitty

getFieldAsWikitty

getFieldAsList

getFieldAsWikittyList

getFieldAsSet

getFieldAsWikittySet

addToField

removeFromField

clearField

addToField

removeFromField

clearField

fieldNames

getFieldValue

getAllFieldNames

getFqField

getVersion

getWikittyVersion

setVersion

setWikittyVersion

getDirty

clearDirty

setFqField

isEmpty

clone

toString

toStringAllField