Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
// =================================================================================================
// ADOBE SYSTEMS INCORPORATED
// Copyright 2006 Adobe Systems Incorporated
// All Rights Reserved
//
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance with the terms
// of the Adobe license agreement accompanying it.
// =================================================================================================
package com.ashampoo.xmp.impl
import com.ashampoo.xmp.XMPConst
import com.ashampoo.xmp.XMPError
import com.ashampoo.xmp.XMPException
import com.ashampoo.xmp.options.PropertyOptions
/**
* A node in the internally XMP tree, which can be a schema node, a property node, an array node,
* an array item, a struct node or a qualifier node (without '?').
*/
class XMPNode(
/**
* name of the node, contains different information depending of the node kind
*/
var name: String?,
/**
* value of the node, contains different information depending of the node kind
*/
var value: String?,
/**
* options describing the kind of the node
*/
var options: PropertyOptions = PropertyOptions()
) : Comparable {
var parent: XMPNode? = null
private var children: MutableList? = null
private var qualifier: MutableList? = null
/* Internal processing options */
var isImplicit = false
var hasAliases = false
var isAlias = false
var hasValueChild = false
fun clear() {
name = null
value = null
options = PropertyOptions()
children = null
qualifier = null
}
/**
* Returns the children or empty list, if there are none.
* Will not lazily create the list!
*/
fun getChildren(): List =
children ?: emptyList()
fun getChild(index: Int): XMPNode =
getOrCreateChildren()[index - 1]
fun addChild(node: XMPNode) {
assertChildNotExisting(node.name!!)
node.parent = this
getOrCreateChildren().add(node)
}
fun addChild(index: Int, node: XMPNode) {
assertChildNotExisting(node.name!!)
node.parent = this
getOrCreateChildren().add(index - 1, node)
}
/**
* Replaces a node with another one.
*/
fun replaceChild(index: Int, node: XMPNode) {
node.parent = this
getOrCreateChildren()[index - 1] = node
}
fun removeChild(itemIndex: Int) {
getOrCreateChildren().removeAt(itemIndex - 1)
cleanupChildren()
}
/**
* Removes a child node.
* If its a schema node and doesn't have any children anymore, its deleted.
*/
fun removeChild(node: XMPNode) {
getOrCreateChildren().remove(node)
cleanupChildren()
}
/**
* Removes the children list if this node has no children anymore;
* checks if the provided node is a schema node and doesn't have any children anymore, its deleted.
*/
private fun cleanupChildren() {
if (children?.isEmpty() == null)
children = null
}
/**
* Removes all children from the node.
*/
fun removeChildren() {
children = null
}
fun getChildrenLength(): Int =
children?.size ?: 0
fun findChildByName(expr: String?): XMPNode? =
getOrCreateChildren().find { it.name == expr }
/**
* Returns the qualifier or empty list, if there are none.
* Will not lazily create the list!
*/
fun getQualifier(): List =
qualifier ?: emptyList()
fun getQualifier(index: Int): XMPNode =
getOrCreateQualifier()[index - 1]
fun getQualifierLength(): Int =
qualifier?.size ?: 0
fun addQualifier(qualNode: XMPNode) {
assertQualifierNotExisting(qualNode.name!!)
qualNode.parent = this
qualNode.options.setQualifier(true)
options.setHasQualifiers(true)
// contraints
if (XMPConst.XML_LANG == qualNode.name) {
// "xml:lang" is always first and the option "hasLanguage" is set
options.setHasLanguage(true)
getOrCreateQualifier().add(0, qualNode)
} else if (XMPConst.RDF_TYPE == qualNode.name) {
// "rdf:type" must be first or second after "xml:lang" and the option "hasType" is set
options.setHasType(true)
getOrCreateQualifier().add(
if (!options.hasLanguage()) 0 else 1,
qualNode
)
} else {
// other qualifiers are appended
getOrCreateQualifier().add(qualNode)
}
}
/**
* Removes one qualifier node and fixes the options.
*/
fun removeQualifier(qualNode: XMPNode) {
if (XMPConst.XML_LANG == qualNode.name) {
// if "xml:lang" is removed, remove hasLanguage-flag too
options.setHasLanguage(false)
} else if (XMPConst.RDF_TYPE == qualNode.name) {
// if "rdf:type" is removed, remove hasType-flag too
options.setHasType(false)
}
getOrCreateQualifier().remove(qualNode)
if (qualifier!!.isEmpty()) {
options.setHasQualifiers(false)
qualifier = null
}
}
/**
* Removes all qualifiers from the node and sets the options appropriate.
*/
fun removeQualifiers() {
// clear qualifier related options
options.setHasQualifiers(false)
options.setHasLanguage(false)
options.setHasType(false)
qualifier = null
}
fun findQualifierByName(expr: String?): XMPNode? =
qualifier?.find { it.name == expr }
fun hasChildren(): Boolean =
children?.isNotEmpty() ?: false
fun iterateChildren(): Iterator =
children?.iterator() ?: emptySequence().iterator()
fun iterateChildrenMutable(): MutableIterator =
children?.listIterator() ?: mutableListOf().listIterator()
fun hasQualifier(): Boolean =
qualifier?.isNotEmpty() ?: false
fun iterateQualifier(): Iterator =
qualifier?.listIterator() ?: emptySequence().iterator()
override fun compareTo(other: XMPNode): Int {
if (options.isSchemaNode())
return value!!.compareTo(other.value!!)
return name!!.compareTo(other.name!!)
}
/**
* Sorts the complete datamodel according to the following rules:
*
* * Nodes at one level are sorted by name, that is prefix + local name
* * Starting at the root node the children and qualifier are sorted recursively,
* which the following exceptions.
* * Sorting will not be used for arrays.
* * Within qualifier "xml:lang" and/or "rdf:type" stay at the top in that order, all others are sorted.
*/
fun sort() {
// sort qualifier
if (hasQualifier()) {
val quals = getOrCreateQualifier().toTypedArray()
var sortFrom = 0
while (quals.size > sortFrom &&
(XMPConst.XML_LANG == quals[sortFrom].name || XMPConst.RDF_TYPE == quals[sortFrom].name)
) {
quals[sortFrom].sort()
sortFrom++
}
quals.sort(sortFrom, quals.size)
val iterator = qualifier!!.listIterator()
for (j in quals.indices) {
iterator.next()
iterator.set(quals[j])
quals[j].sort()
}
}
// sort children
if (hasChildren()) {
if (!options.isArray())
children!!.sort()
val it = iterateChildren()
while (it.hasNext())
it.next().sort()
}
}
// ------------------------------------------------------------------------------ private methods
private fun getOrCreateChildren(): MutableList {
if (children == null)
children = mutableListOf()
return children!!
}
private fun getOrCreateQualifier(): MutableList {
if (qualifier == null)
qualifier = mutableListOf()
return qualifier!!
}
/**
* Checks that a node name is not existing on the same level, except for array items.
*/
private fun assertChildNotExisting(childName: String) {
if (XMPConst.ARRAY_ITEM_NAME != childName && findChildByName(childName) != null)
throw XMPException("Duplicate property or field node '$childName'", XMPError.BADXMP)
}
/**
* Checks that a qualifier name is not existing on the same level.
*/
private fun assertQualifierNotExisting(qualifierName: String) {
if (XMPConst.ARRAY_ITEM_NAME != qualifierName && findQualifierByName(qualifierName) != null)
throw XMPException("Duplicate '$qualifierName' qualifier", XMPError.BADXMP)
}
}
