Author: mfortun Date: 2011-07-12 17:29:48 +0200 (Tue, 12 Jul 2011) New Revision: 1078 Url: http://nuiton.org/repositories/revision/wikitty/1078 Log: * add some documentation Modified: trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/externalize/AbstractDecoredClass.java trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/externalize/WikittyPublicationClassLoader.java trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/externalize/WikittyServiceJarLoader.java trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/synchro/AbstractWikittyFileService.java trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/synchro/MimeTypePubHelper.java trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/synchro/WikittyFileUtil.java trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/synchro/WikittyPublicationFileSystem.java Modified: trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/externalize/AbstractDecoredClass.java =================================================================== --- trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/externalize/AbstractDecoredClass.java 2011-07-12 09:34:27 UTC (rev 1077) +++ trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/externalize/AbstractDecoredClass.java 2011-07-12 15:29:48 UTC (rev 1078) @@ -2,6 +2,18 @@ import java.util.Map; + +/** + * Abstract class for the skeleton and signature for wikittyPubText content + * transform and compile as Java class. + * + * This class allow the evaluator engine to call the eval method to return + * the result of the compiled code from the wikitty pub text content. + * + * + * @author mfortun + * + */ public abstract class AbstractDecoredClass { Modified: trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/externalize/WikittyPublicationClassLoader.java =================================================================== --- trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/externalize/WikittyPublicationClassLoader.java 2011-07-12 09:34:27 UTC (rev 1077) +++ trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/externalize/WikittyPublicationClassLoader.java 2011-07-12 15:29:48 UTC (rev 1078) @@ -1,11 +1,24 @@ package org.nuiton.wikitty.publication.externalize; + +/** + * A simple classloader extension to allow adding java class with bytecode + * @author mfortun + * + */ public class WikittyPublicationClassLoader extends ClassLoader { public WikittyPublicationClassLoader() { super(WikittyPublicationClassLoader.class.getClassLoader()); } + + /** + * use to add a class inside the class path from bytecode + * @param name the name of the class + * @param b the bytecode of the class + * @return the class loaded + */ public Class<?> addClass(String name, byte[] b) { int off = 0; int len = b.length; Modified: trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/externalize/WikittyServiceJarLoader.java =================================================================== --- trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/externalize/WikittyServiceJarLoader.java 2011-07-12 09:34:27 UTC (rev 1077) +++ trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/externalize/WikittyServiceJarLoader.java 2011-07-12 15:29:48 UTC (rev 1078) @@ -24,10 +24,14 @@ import org.nuiton.wikitty.entities.Wikitty; import org.nuiton.wikitty.entities.WikittyExtension; import org.nuiton.wikitty.entities.WikittyImpl; +import org.nuiton.wikitty.entities.WikittyLabel; import org.nuiton.wikitty.entities.WikittyLabelHelper; import org.nuiton.wikitty.entities.WikittyLabelImpl; +import org.nuiton.wikitty.publication.entities.WikittyPubData; import org.nuiton.wikitty.publication.entities.WikittyPubDataHelper; import org.nuiton.wikitty.publication.entities.WikittyPubDataImpl; +import org.nuiton.wikitty.publication.entities.WikittyPubText; +import org.nuiton.wikitty.publication.entities.WikittyPubTextCompiled; import org.nuiton.wikitty.publication.entities.WikittyPubTextCompiledHelper; import org.nuiton.wikitty.publication.entities.WikittyPubTextCompiledImpl; import org.nuiton.wikitty.publication.entities.WikittyPubTextHelper; @@ -197,10 +201,14 @@ @Override public List<String> getAllExtensionIds(String securityToken) { - // TODO mfortun - throw new UnsupportedOperationException("not yet implemented"); - // return null; + List<String> result = new LinkedList<String>(); + result.add(WikittyPubData.EXT_WIKITTYPUBDATA); + result.add(WikittyPubText.EXT_WIKITTYPUBTEXT); + result.add(WikittyPubTextCompiled.EXT_WIKITTYPUBTEXTCOMPILED); + result.add(WikittyLabel.EXT_WIKITTYLABEL); + + return result; } @Override Modified: trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/synchro/AbstractWikittyFileService.java =================================================================== --- trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/synchro/AbstractWikittyFileService.java 2011-07-12 09:34:27 UTC (rev 1077) +++ trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/synchro/AbstractWikittyFileService.java 2011-07-12 15:29:48 UTC (rev 1078) @@ -37,6 +37,16 @@ import org.nuiton.wikitty.search.operators.RestrictionName; import org.nuiton.wikitty.search.operators.True; + +/** + * This service must be extends by wikitty service that are over file system + * directly or this kind of storage for wikitty. + * + * + * + * @author mfortun + * + */ public abstract class AbstractWikittyFileService implements WikittyService{ @@ -45,6 +55,16 @@ public AbstractWikittyFileService() { super(); } + + /** + * Method that must be implemented by the extended service. This must return + * all the wikitty stored. The result will be use to checkrestriction for + * a find. + * @return a Map with wikittyId as Key and wikitty as value + */ + protected abstract Map<String, Wikitty> getAllWikitties(); + + /** * Write by jcouteau, used to check if a wikitty check a restriction @@ -429,10 +449,7 @@ } } - - protected abstract Map<String, Wikitty> getAllWikitties(); - - + @Override public List<PagedResult<String>> findAllByCriteria(String securityToken, List<Criteria> criteria) { Modified: trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/synchro/MimeTypePubHelper.java =================================================================== --- trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/synchro/MimeTypePubHelper.java 2011-07-12 09:34:27 UTC (rev 1077) +++ trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/synchro/MimeTypePubHelper.java 2011-07-12 15:29:48 UTC (rev 1078) @@ -114,14 +114,17 @@ return mimePubText.contains(mimeType); } - + /** + * used to check if a file have to be converted as a wikittyPubText + * with his extension similar to : + * <br>isPubTextMime(getMimeForExtension(extension))</br> + * @param extension the file extension + * @return if the extension correspond to a wikittyPubText + */ public boolean isPubTextExtension(String extension) { return isPubTextMime(getMimeForExtension(extension)); } - - - /** * Add a mimeType corresponding to a WikittyPubText * Modified: trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/synchro/WikittyFileUtil.java =================================================================== --- trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/synchro/WikittyFileUtil.java 2011-07-12 09:34:27 UTC (rev 1077) +++ trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/synchro/WikittyFileUtil.java 2011-07-12 15:29:48 UTC (rev 1078) @@ -8,6 +8,14 @@ import org.nuiton.util.FileUtil; import org.nuiton.util.StringUtil; + +/** + * + * Class that containt utils method when handle wikitty store as file. + * + * @author mfortun + * + */ public class WikittyFileUtil { /** Modified: trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/synchro/WikittyPublicationFileSystem.java =================================================================== --- trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/synchro/WikittyPublicationFileSystem.java 2011-07-12 09:34:27 UTC (rev 1077) +++ trunk/wikitty-publication/src/main/java/org/nuiton/wikitty/publication/synchro/WikittyPublicationFileSystem.java 2011-07-12 15:29:48 UTC (rev 1078) @@ -34,6 +34,7 @@ import java.util.ArrayList; import java.util.Collection; import java.util.HashMap; +import java.util.LinkedList; import java.util.List; import java.util.Map; import java.util.Properties; @@ -52,6 +53,7 @@ import org.nuiton.wikitty.entities.Wikitty; import org.nuiton.wikitty.entities.WikittyExtension; import org.nuiton.wikitty.entities.WikittyImpl; +import org.nuiton.wikitty.entities.WikittyLabel; import org.nuiton.wikitty.entities.WikittyLabelHelper; import org.nuiton.wikitty.entities.WikittyLabelImpl; import org.nuiton.wikitty.publication.entities.WikittyPubData; @@ -488,10 +490,14 @@ @Override public List<String> getAllExtensionIds(String securityToken) { - // TODO mfortun-2011-04-05 - throw new UnsupportedOperationException("not yet implemented"); - // return null; + List<String> result = new LinkedList<String>(); + result.add(WikittyPubData.EXT_WIKITTYPUBDATA); + result.add(WikittyPubText.EXT_WIKITTYPUBTEXT); + //result.add(WikittyPubTextCompiled.EXT_WIKITTYPUBTEXTCOMPILED); + result.add(WikittyLabel.EXT_WIKITTYLABEL); + + return result; } @Override @@ -853,7 +859,7 @@ log.debug("restore wikitty id:" + id + " file: " + fileId); Wikitty result = new WikittyImpl(id); - + result.addExtension(WikittyLabelImpl.extensionWikittyLabel); // preparation for mime research and file research