Android - Revision history

CG: Text replacement - "syntaxhighlight" to "pre"

2023-12-01T16:39:50Z

Text replacement - "syntaxhighlight" to "pre"

CG: Text replacement - "" to ""

2023-12-01T16:34:59Z

Text replacement - "</syntaxhighlight>" to "</pre>"

CG at 11:15, 2 July 2020

2020-07-02T11:15:53Z

CG at 10:45, 2 July 2020

2020-07-02T10:45:07Z

CG at 10:44, 2 July 2020

2020-07-02T10:44:06Z

CG at 11:56, 27 February 2020

2020-02-27T11:56:41Z

Show changes

CG at 13:03, 12 March 2018

2018-03-12T13:03:16Z

Stephan at 11:25, 10 April 2014

2014-04-10T11:25:10Z

Stephan at 10:38, 10 April 2014

2014-04-10T10:38:40Z

Stephan at 10:16, 10 April 2014

2014-04-10T10:16:06Z

@@ Line 37: / Line 37: @@
 The following source code shows a minimal example for a BaseX class.
-<syntaxhighlight lang="java">
+<pre lang="java">
 public class BaseXDatabase {
 	private Context basexContext = null;
@@ Line 50: / Line 50: @@
 This class can be called in every Android application which uses the BaseX library with the following call, for example:
-<syntaxhighlight lang="java">
+<pre lang="java">
 BaseXDatabase baseXDatabase = new BaseXDatabase(getApplicationInfo().dataDir);
 </pre>
@@ Line 59: / Line 59: @@
 The following code shows the changes inside the Context.java file:
-<syntaxhighlight lang="java">
+<pre lang="java">
 public Context(String data_dir) {
 	this(true, (Prop.HOME = data_dir + "/"), (Prop.USERHOME = data_dir + "/"));
@@ Line 86: / Line 86: @@
 The following lines need to be removed:
-<syntaxhighlight lang="java">
+<pre lang="java">
    /** XQuery function. */
    _CRYPTO_HMAC(FNCrypto.class, "hmac(message,key,algorithm[,encoding])",
@@ Line 122: / Line 122: @@
 An example of this can be seen in the following code:
-<syntaxhighlight lang="java">
+<pre lang="java">
 public String executeXQuery(String query) throws IOException {
 	if(basexContext != null)
@@ Line 139: / Line 139: @@
 Using Gradle, the Android build system, it can be done by adding the following line to the gradle build file. This tells the build system that every library, inside the libs folder, is being compiled into the projects file.
-<syntaxhighlight lang="java">
+<pre lang="java">
 dependencies {
      compile fileTree(dir: 'libs', include: ['*.jar', '*.aar'])
+}
 </pre>

@@ Line 46: / Line 46: @@
+}
-</syntaxhighlight>
+</pre>
 This class can be called in every Android application which uses the BaseX library with the following call, for example:
@@ Line 52: / Line 52: @@
 <syntaxhighlight lang="java">
 BaseXDatabase baseXDatabase = new BaseXDatabase(getApplicationInfo().dataDir);
-</syntaxhighlight>
+</pre>
 At the moment it is not possible to use the BaseX library, therefore more adjustments have to be done in the BaseX code.
@@ Line 73: / Line 73: @@
    this(new MainProp(file));
+}
-</syntaxhighlight>
+</pre>
 As shown in the adjustment above, it is necessary to set the two variables 'Prop.HOME' and Prop.USERHOME' during the constructor call. In the BaseX code those variables are final, which need also be changed in order to set them during the call.
@@ Line 104: / Line 104: @@
    URIS.put(FNCrypto.class, CRYPTOURI);
-</syntaxhighlight>
+</pre>
 The result of this adjustment is, that it is now possible to use BaseX as an Android library, with the lack of support of the following XQuery functions:
@@ Line 130: / Line 130: @@
 	return "";
+}
-</syntaxhighlight>
+</pre>
 This methods of the BaseXDatabase class can now be used in every Android application which includes the created BaseX Android library.
@@ Line 143: / Line 143: @@
      compile fileTree(dir: 'libs', include: ['*.jar', '*.aar'])
+}
-</syntaxhighlight>
+</pre>

@@ Line 134: / Line 134: @@
 This methods of the BaseXDatabase class can now be used in every Android application which includes the created BaseX Android library.
-It is possible to create a .jar, or an .aar[http://tools.android.com/tech-docs/new-build-system/aar-format] file out of the BaseX library, by just building the source code.
+It is possible to create a .jar, or an [http://tools.android.com/tech-docs/new-build-system/aar-format .aar file] out of the BaseX library, by just building the source code.
 This file need to be copied inside the lib folder of the Android project which wants to use the library. Additionally the build file of the application needs to be adjusted to use the library.

@@ Line 77: / Line 77: @@
 As shown in the adjustment above, it is necessary to set the two variables 'Prop.HOME' and Prop.USERHOME' during the constructor call. In the BaseX code those variables are final, which need also be changed in order to set them during the call.
-The reason for this change is that the in BaseX used System.getProperty(user.dir) returns an empty string in Android[http://developer.android.com/reference/java/lang/System.html#getProperty(java.lang.String)].
+The reason for this change is that the in BaseX used System.getProperty(user.dir) returns an [https://developer.android.com/reference/java/lang/System.html#getProperty(java.lang.String) empty string in Android].
 ----

@@ Line 1: / Line 1: @@
 It is possible to create an Android port of BaseX. The present tutorial outlines the creation of a BaseX Android library, which can be used in any other application project.
-For the creation of the library the IDE Android Studio[http://developer.android.com/sdk/installing/studio.html] is used, but the steps are more or less equal using the Eclipse IDE.
+For the creation of the library the [https://developer.android.com/studio IDE Android Studio] is used, but the steps are more or less equal using the Eclipse IDE.
 ----

@@ Line 50: / Line 50: @@
 public Context(String data_dir) {
 	this(true, (Prop.HOME = data_dir + "/"), (Prop.USERHOME = data_dir + "/"));
-	File dir = new File(Prop.HOME + "BaseXData");
+	File dir = new File(Prop.HOME, "basex/data");
 	if(!dir.exists()) {
 		if(!dir.mkdir()) {

@@ Line 1: / Line 1: @@
 It is possible to create an Android port of BaseX.
 Therefore the present tutorial outlines the creation of a BaseX Android library, which can be used in any other application project.
-For the creation of the library the IDE Android Studio[http://developer.android.com/sdk/installing/studio.html] is used, but the steps are more or less equal in the IDE Eclipse.
+For the creation of the library the IDE Android Studio[http://developer.android.com/sdk/installing/studio.html] is used, but the steps are more or less equal using the Eclipse IDE.
 ----
@@ Line 99: / Line 99: @@
 == Using the BaseX Android Library ==

← Older revision		Revision as of 10:38, 10 April 2014
Line 64:		Line 64:
	As shown in the adjustment above, it is necessary to set the two variables 'Prop.HOME' and Prop.USERHOME' during the constructor call. In the BaseX code those variables are final, which need also be changed in order to set them during the call.<br>		As shown in the adjustment above, it is necessary to set the two variables 'Prop.HOME' and Prop.USERHOME' during the constructor call. In the BaseX code those variables are final, which need also be changed in order to set them during the call.<br>
	The reason for this change is that the in BaseX used System.getProperty(user.dir) returns an empty string in Android[http://developer.android.com/reference/java/lang/System.html#getProperty(java.lang.String)].		The reason for this change is that the in BaseX used System.getProperty(user.dir) returns an empty string in Android[http://developer.android.com/reference/java/lang/System.html#getProperty(java.lang.String)].
		+
		+	----
		+	The next adjustment, which needs to be done, is to remove not supported packages inside the BaseX code.
		+	Therefore the package 'org.basex.query.util.crypto' need to be removed, because it uses external packages which are not supported by Android.
		+	The class which uses these files can be found inside the FNCrypto.java file in the 'query.func' package. This file needs to be deleted as well as its usage inside the Function.java file, which can also be found inside the 'query.func' package.
		+	The following lines need to be removed:
		+	<pre class="brush:java">
		+	/** XQuery function. */
		+	_CRYPTO_HMAC(FNCrypto.class, "hmac(message,key,algorithm[,encoding])",
		+	arg(STR, STR, STR, STR_ZO), STR),
		+	/** XQuery function. */
		+	_CRYPTO_ENCRYPT(FNCrypto.class, "encrypt(input,encryption,key,algorithm)",
		+	arg(STR, STR, STR, STR), STR),
		+	/** XQuery function. */
		+	_CRYPTO_DECRYPT(FNCrypto.class, "decrypt(input,type,key,algorithm)",
		+	arg(STR, STR, STR, STR), STR),
		+	/** XQuery function. */
		+	_CRYPTO_GENERATE_SIGNATURE(FNCrypto.class, "generate-signature" +
		+	"(input,canonicalization,digest,signature,prefix,type[,item1][,item2])",
		+	arg(NOD, STR, STR, STR, STR, STR, ITEM_ZO, ITEM_ZO), NOD),
		+	/** XQuery function. */
		+	_CRYPTO_VALIDATE_SIGNATURE(FNCrypto.class, "validate-signature(node)", arg(NOD), BLN),
		+
		+	URIS.put(FNCrypto.class, CRYPTOURI);
		+	</pre>
		+	The result of this adjustment is, that it is now possible to use BaseX as an Android library, with the lack of support of the following XQuery functions:<br>
		+	*hmac(string,string,string[,string])
		+	*encrypt(string,string,string,string)
		+	*decrypt(string,string,string,string)
		+	*generate-signature(node,string,string,string,string,string[,item][,item])
		+	*validate-signature(node)
		+
		+	----
		+
		+	== Using the BaseX Android Library ==

@@ Line 27: / Line 27: @@
 <br>
 In the empty android package a new Java class needs to be created, this class is used to create the necessary BaseX files and communicate with BaseX. This class needs the data directory of the application for storing the corresponding BaseX files. This files should be stored in the apps /data/data/.. folder which is only accessible from the application.
-This information is only available inside the applications context and not inside a library project, therefore it is neccessary to pass this information to this class at the constructor call.
+This information is only available inside the applications context and not inside a library project, therefore it is necessary to pass this information to this class at the constructor call.
 The following source code shows a minimal example for a BaseX class.
-'''Example:'''
 <pre class="brush:java">
 public class BaseXDatabase {
@@ Line 44: / Line 44: @@
 BaseXDatabase baseXDatabase = new BaseXDatabase(getApplicationInfo().dataDir);
 </pre>