|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.nuiton.wikitty.WikittyClient
public class WikittyClient
Wikitty client is object used in client side to access WikittyService.
It is used to transform wikitty object used by WikittyService
into business objects used by applications.
It also manage securityToken for WikittyService.
All method that need securityToken and WikittyService
must be in this class and not in WikittyUtil
| Field Summary | |
|---|---|
protected org.nuiton.util.ApplicationConfig |
config
|
protected String |
securityToken
Security token. |
protected WikittyServiceEnhanced |
wikittyService
Delegated wikitty service. |
| Constructor Summary | |
|---|---|
protected |
WikittyClient()
Empty constructor (uninitialized wikittyService). |
|
WikittyClient(org.nuiton.util.ApplicationConfig config)
Creation du client, le wikittyService est instancier grace au information trouve dans la configuration. |
|
WikittyClient(org.nuiton.util.ApplicationConfig config,
WikittyService wikittyService)
Creation du client en forcant le wikittyService |
|
WikittyClient(org.nuiton.util.ApplicationConfig config,
WikittyService wikittyService,
String securityToken)
Creation du client en forcant le wikittyService |
| Method Summary | ||
|---|---|---|
|
castTo(Class<E> target,
List<F> objects)
Convert all objects in list parameter to the wanted type and return new List. |
|
|
castTo(Class<E> target,
Object e)
Convert e parameter to the wanted type and return it. |
|
|
castTo(Class<E> target,
WikittyQueryResult queryResult)
Convert all result to the wanted type and return new WikittyQueryResult with this new result list. |
|
WikittyEvent |
clear()
Use with caution : It will delete ALL indexes from search engine ! |
|
void |
delete(Collection<String> ids)
|
|
|
delete(E object)
|
|
|
delete(List<E> objets)
|
|
void |
delete(String id)
|
|
void |
deleteExtension(Collection<String> extNames)
|
|
void |
deleteExtension(String extName)
|
|
WikittyEvent |
deleteTree(String treeNodeId)
Delete specified tree node and all sub nodes. |
|
|
findAllByExample(E e,
int first,
int limit,
ElementField... fieldFacet)
Null field are not used in search request. |
|
|
findAllByQuery(Class<E> clazz,
List<WikittyQuery> queries)
Search object that correspond to criteria and that have all extension needed by BusinessEntity (clazz), if clazz is BusinessEntity class. |
|
protected
|
findAllByQuery(Class<E> clazz,
List<WikittyQuery> queries,
boolean limitToFirst)
Cette method doit etre l'unique methode finalement utilise par toutes les methodes find avec un cast vers clazz Search object that correspond to criteria and that have all extension needed by BusinessEntity (clazz), if clazz is BusinessEntity class. |
|
|
findAllByQuery(Class<E> clazz,
WikittyQuery query)
Search object that correspond to criteria and that have all extension needed by BusinessEntity (clazz), if clazz is BusinessEntity class. |
|
|
findAllByQuery(Class<E> clazz,
WikittyQuery q1,
WikittyQuery q2,
WikittyQuery... otherQueries)
/** Search object that correspond to criteria and that have all extension needed by BusinessEntity (clazz), if clazz is BusinessEntity class. |
|
List<WikittyQueryResult<String>> |
findAllByQuery(List<WikittyQuery> query)
Retourne les ids des wikitties qui correspondent au critere, chaque query passees en argument et retourne un WikittyQueryResult. |
|
WikittyQueryResult<String> |
findAllByQuery(WikittyQuery query)
|
|
WikittyQueryResult<String>[] |
findAllByQuery(WikittyQuery c1,
WikittyQuery c2,
WikittyQuery... otherCriteria)
|
|
WikittyQueryResultTreeNode<String> |
findAllIdTreeNode(String wikittyId,
int depth,
boolean count,
WikittyQuery filter)
Recupere une portion d'arbre a partir de l'id passer en parametre. |
|
|
findByExample(E e)
Null field are not used in search request. |
|
|
findByQuery(Class<E> clazz,
List<WikittyQuery> queries)
|
|
|
findByQuery(Class<E> clazz,
WikittyQuery query)
|
|
|
findByQuery(Class<E> clazz,
WikittyQuery q1,
WikittyQuery q2,
WikittyQuery... otherQueries)
|
|
List<String> |
findByQuery(List<WikittyQuery> query)
|
|
String |
findByQuery(WikittyQuery query)
|
|
String[] |
findByQuery(WikittyQuery q1,
WikittyQuery q2,
WikittyQuery... otherQueries)
|
|
|
findTreeNode(Class<E> clazz,
String wikittyId,
int depth,
boolean count,
WikittyQuery filter)
Recupere une portion d'arbre a partir de l'id passer en parametre. |
|
WikittyQueryResultTreeNode<Wikitty> |
findTreeNode(String wikittyId,
int depth,
boolean count,
WikittyQuery filter)
Recupere une portion d'arbre a partir de l'id passer en parametre. |
|
List<String> |
getAllExtensionIds()
Return all extension id (ex: "extName[version])"). |
|
List<String> |
getAllExtensionsRequires(String extensionName)
Return all extension id (ex: "extName[version])") where extensionName is required. |
|
static Map<String,org.nuiton.util.TimeLog.CallStat> |
getCallCount()
|
|
org.nuiton.util.ApplicationConfig |
getConfig()
|
|
WikittyUser |
getLoggedInUser()
Get the #WikittyUser that is logged in. |
|
WikittyExtensionMigrationRegistry |
getMigrationRegistry()
|
|
String |
getSecurityToken()
|
|
static org.nuiton.util.TimeLog |
getTimeTrace()
|
|
WikittyUser |
getUser()
get current wikittyUser logged or null if no user logged |
|
|
getUser(Class<E> clazz)
get current logged user wikitty object |
|
Wikitty |
getWikitty(BusinessEntity entity)
Deprecated. since 3.4 use castTo(java.lang.Class, Object) |
|
protected Set<Wikitty> |
getWikittyForPreload(Map<String,Wikitty> available,
Wikitty w,
FieldType type,
String fqField)
|
|
WikittyService |
getWikittyService()
|
|
boolean |
isMember(String groupName)
Check that the logged in user is in a group. |
|
void |
login(String login,
String password)
|
|
void |
logout()
|
|
void |
preload(Collection<Wikitty> wikitties,
String... preloadPattern)
Ajoute le preloadPattern comme chaine de preload dans chaque wikitty et fait le prechargement sur chaque wikitty. |
|
protected void |
preload(Wikitty w,
Map<String,Wikitty> available,
Set<String> loaded)
Preload recursivement le wikitty, en fonction de sa chaine preloadPattern et des tags values des extensions qu'il a.. |
|
protected void |
preload(Wikitty w,
Map<String,Wikitty> available,
Set<String> loaded,
String preloadPattern)
Load one wikitty with specified preloadPattern (with only ','). |
|
|
restore(Class<E> clazz,
List<String> id,
boolean checkExtension,
String... preload)
Restore wikitty entity with specified id or null if entity
can't be be found, or checkExtension is true and wikitty don't match
extension wanted. |
|
|
restore(Class<E> clazz,
List<String> id,
String... preload)
|
|
|
restore(Class<E> clazz,
Set<String> id,
boolean checkExtension,
String... preload)
|
|
|
restore(Class<E> clazz,
Set<String> id,
String... preload)
|
|
|
restore(Class<E> clazz,
String id,
boolean checkExtension,
String... preload)
Restore wikitty entity with specified id or null if entity can't be found. |
|
|
restore(Class<E> clazz,
String id,
String... preload)
Restore wikitty entity with specified id or null if entity can't be found. |
|
List<Wikitty> |
restore(List<String> id,
String... preload)
Restore wikitty entity with specified id or null if entity can't be be found. |
|
Set<Wikitty> |
restore(Set<String> id,
String... preload)
|
|
Wikitty |
restore(String id,
String... preload)
Restore wikitty entity with specified id or null if entity can't be found. |
|
WikittyExtension |
restoreExtension(String extensionId)
Load extension from id. |
|
List<WikittyExtension> |
restoreExtensionAndDependenciesLastVesion(Collection<String> extensionNames)
Search extension with name in last version. |
|
WikittyExtension |
restoreExtensionLastVersion(String extensionName)
Search extension with name in last version. |
|
Wikitty |
restoreVersion(String wikittyId,
String version)
|
|
void |
setSecurityToken(String securityToken)
|
|
void |
setWikittyService(WikittyService wikittyService)
|
|
|
store(E e)
|
|
|
store(E e1,
E e2,
E... eN)
|
|
|
store(List<E> objets)
Store to WikittyService objects. |
|
Wikitty |
store(Wikitty w)
|
|
Wikitty[] |
store(Wikitty w1,
Wikitty w2,
Wikitty... wN)
|
|
WikittyEvent |
storeExtension(Collection<WikittyExtension> exts)
Manage Update and creation. |
|
WikittyEvent |
storeExtension(WikittyExtension ext)
Manage Update and creation. |
|
List<Wikitty> |
storeWikitty(List<Wikitty> wikitties)
|
|
void |
syncSearchEngine()
Synchronize search engine with wikitty storage engine, i.e. clear and reindex all object. |
|
protected Number |
toNumber(Class target,
BigDecimal v)
|
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected org.nuiton.util.ApplicationConfig config
protected WikittyServiceEnhanced wikittyService
protected String securityToken
WikittyServiceAuthentication.login(String, String)| Constructor Detail |
|---|
protected WikittyClient()
public WikittyClient(org.nuiton.util.ApplicationConfig config)
config -
public WikittyClient(org.nuiton.util.ApplicationConfig config,
WikittyService wikittyService)
config - wikittyService -
public WikittyClient(org.nuiton.util.ApplicationConfig config,
WikittyService wikittyService,
String securityToken)
config - wikittyService - securityToken - | Method Detail |
|---|
public static org.nuiton.util.TimeLog getTimeTrace()
public static Map<String,org.nuiton.util.TimeLog.CallStat> getCallCount()
public WikittyExtensionMigrationRegistry getMigrationRegistry()
public void login(String login,
String password)
public void logout()
public String getSecurityToken()
public void setSecurityToken(String securityToken)
public WikittyUser getUser()
public <E extends BusinessEntity> E getUser(Class<E> clazz)
clazz - Business class used as User in your application,
this extension should be require WikittyUser.
public WikittyService getWikittyService()
public void setWikittyService(WikittyService wikittyService)
public org.nuiton.util.ApplicationConfig getConfig()
public Wikitty store(Wikitty w)
public <E extends BusinessEntity> E store(E e)
public <E extends BusinessEntity> E[] store(E e1,
E e2,
E... eN)
public Wikitty[] store(Wikitty w1,
Wikitty w2,
Wikitty... wN)
public <E extends BusinessEntity> List<E> store(List<E> objets)
E - object typeobjets - list
public List<Wikitty> storeWikitty(List<Wikitty> wikitties)
protected Set<Wikitty> getWikittyForPreload(Map<String,Wikitty> available,
Wikitty w,
FieldType type,
String fqField)
protected void preload(Wikitty w,
Map<String,Wikitty> available,
Set<String> loaded,
String preloadPattern)
w - current wikitty to loadavailable - available wikitty (restored)loaded - already loaded wikitties + field couplepreloadPattern - pattern used to load
protected void preload(Wikitty w,
Map<String,Wikitty> available,
Set<String> loaded)
w - le wikitty a prechargeravailable - la liste des wikitty deja disponible sans restore expliciteloaded - la liste de couple wid + fqfield deja traite
public void preload(Collection<Wikitty> wikitties,
String... preloadPattern)
wikitties - la liste des wikitties a prechargerpreloadPattern - la liste des patterns de prechargement a faire
public List<Wikitty> restore(List<String> id,
String... preload)
null if entity can't be be found.
id - entity ids if null return is empty listpreload - patterns des liens qu'il faut precharger par exemple:
"Company.employee, Employee.person", "Company.address, Address.*"
null if entity can't be found
public Wikitty restore(String id,
String... preload)
null if entity can't be found.
id - entity id
null if entity can't be found
public <E extends BusinessEntity> List<E> restore(Class<E> clazz,
List<String> id,
boolean checkExtension,
String... preload)
null if entity
can't be be found, or checkExtension is true and wikitty don't match
extension wanted.
E - object typeclazz - entity classid - entity ids if null return is empty listcheckExtension - if true check that Wikitty result has all extension
null if entity
can't be found or if one wikitty don't have extension wanted by E type
public <E extends BusinessEntity> E restore(Class<E> clazz,
String id,
String... preload)
null if entity can't be found.
E - object typeclazz - entity classid - entity id
null if entity can't be found
public <E extends BusinessEntity> E restore(Class<E> clazz,
String id,
boolean checkExtension,
String... preload)
null if entity can't be found.
E - object typeclazz - entity classid - entity idcheckExtension - if true check that Wikitty result has all extension
declared in clazz
null if entity can't be found
public <E extends BusinessEntity> List<E> restore(Class<E> clazz,
List<String> id,
String... preload)
public Set<Wikitty> restore(Set<String> id,
String... preload)
public <E extends BusinessEntity> Set<E> restore(Class<E> clazz,
Set<String> id,
String... preload)
public <E extends BusinessEntity> Set<E> restore(Class<E> clazz,
Set<String> id,
boolean checkExtension,
String... preload)
public void delete(String id)
public <E extends BusinessEntity> void delete(E object)
public void delete(Collection<String> ids)
public <E extends BusinessEntity> void delete(List<E> objets)
public <E extends BusinessEntityImpl> WikittyQueryResult<E> findAllByExample(E e,
int first,
int limit,
ElementField... fieldFacet)
e - sample wikittyfirst - limit - fieldFacet -
public <E extends BusinessEntityImpl> E findByExample(E e)
e - sample wikitty
protected <E> List<WikittyQueryResult<E>> findAllByQuery(Class<E> clazz,
List<WikittyQuery> queries,
boolean limitToFirst)
E - object type
Can be Wikitty, BusinessEntity, String, Date, Number (returned is BigDecimal), Boolean, byte[]clazz - entity classqueries - criteriaslimitToFirst - if true limit result to first result (first = 0, limit = 1)
public <E> List<WikittyQueryResult<E>> findAllByQuery(Class<E> clazz,
List<WikittyQuery> queries)
E - object type
Can be Wikitty, BusinessEntity, String, Date, Number (returned is BigDecimal), Boolean, byte[]clazz - entity classqueries - queries
public <E> WikittyQueryResult<E> findAllByQuery(Class<E> clazz,
WikittyQuery query)
E - object type
Can be Wikitty, BusinessEntity, String, Date, Number (returned is BigDecimal), Boolean, byte[]clazz - entity classquery - query
public <E> WikittyQueryResult<E>[] findAllByQuery(Class<E> clazz,
WikittyQuery q1,
WikittyQuery q2,
WikittyQuery... otherQueries)
E - object type
Can be Wikitty, BusinessEntity, String, Date, Number (returned is BigDecimal), Boolean, byte[]clazz - entity classq1 - query 1q2 - query 2otherQueries - otherQueries
public <E> List<E> findByQuery(Class<E> clazz,
List<WikittyQuery> queries)
public <E> E findByQuery(Class<E> clazz,
WikittyQuery query)
public <E> E[] findByQuery(Class<E> clazz,
WikittyQuery q1,
WikittyQuery q2,
WikittyQuery... otherQueries)
public List<WikittyQueryResult<String>> findAllByQuery(List<WikittyQuery> query)
query -
public WikittyQueryResult<String> findAllByQuery(WikittyQuery query)
public WikittyQueryResult<String>[] findAllByQuery(WikittyQuery c1,
WikittyQuery c2,
WikittyQuery... otherCriteria)
public List<String> findByQuery(List<WikittyQuery> query)
public String findByQuery(WikittyQuery query)
public String[] findByQuery(WikittyQuery q1,
WikittyQuery q2,
WikittyQuery... otherQueries)
public WikittyQueryResultTreeNode<Wikitty> findTreeNode(String wikittyId,
int depth,
boolean count,
WikittyQuery filter)
wikittyId - rootdepth - profondeur de noeud a recuperercount - vrai si l'on veut le nombre de piece attaches sur le noeud
(piece des enfants compris)filter - filter pour compter les pieces attachees
public <E extends BusinessEntity> WikittyQueryResultTreeNode<E> findTreeNode(Class<E> clazz,
String wikittyId,
int depth,
boolean count,
WikittyQuery filter)
clazz - business class wanted to replace id in TreeNodeResultwikittyId - rootdepth - profondeur de noeud a recuperercount - vrai si l'on veut le nombre de piece attaches sur le noeud (piece des enfants compris)filter - filter pour compter les pieces attachees
public WikittyQueryResultTreeNode<String> findAllIdTreeNode(String wikittyId,
int depth,
boolean count,
WikittyQuery filter)
wikittyId - depth - count - filter -
public WikittyEvent deleteTree(String treeNodeId)
treeNodeId - tree node id to delete
public Wikitty restoreVersion(String wikittyId,
String version)
public WikittyEvent storeExtension(WikittyExtension ext)
ext - extension to be persisted
public WikittyEvent storeExtension(Collection<WikittyExtension> exts)
exts - list of wikitty extension to be persisted
public WikittyExtension restoreExtension(String extensionId)
extensionId - extension id to restore
public WikittyExtension restoreExtensionLastVersion(String extensionName)
extensionName - extension name
public List<WikittyExtension> restoreExtensionAndDependenciesLastVesion(Collection<String> extensionNames)
extensionNames - extension name
public void deleteExtension(String extName)
public void deleteExtension(Collection<String> extNames)
public List<String> getAllExtensionIds()
public List<String> getAllExtensionsRequires(String extensionName)
extensionName is required.
extensionName - extension name
public WikittyEvent clear()
public void syncSearchEngine()
@Deprecated public Wikitty getWikitty(BusinessEntity entity)
castTo(java.lang.Class, Object)
entity - the BusinessEntity encapsulating the Wikitty
public boolean isMember(String groupName)
groupName - the name of the group to check
public WikittyUser getLoggedInUser()
public <E,F> List<E> castTo(Class<E> target,
List<F> objects)
target - to cast into.
Can be Wikitty, BusinessEntity, String, Date, Number (returned is BigDecimal), Boolean, byte[]objects - objects to convert
protected Number toNumber(Class target,
BigDecimal v)
public <E> E castTo(Class<E> target,
Object e)
target - to cast into.
Can be Wikitty, BusinessEntity, String, Date, Number (returned is BigDecimal), Boolean, byte[]e - object to convert
public <E> WikittyQueryResult<E> castTo(Class<E> target,
WikittyQueryResult queryResult)
queryResult - result to converttarget - to cast into.
Can be Wikitty, BusinessEntity, String, Date, Number (returned is BigDecimal), Boolean, byte[]
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||