* Check rule M1.25: The Relationships part shall not have relationships to * any other part. Package implementers shall enforce this requirement upon * the attempt to create such a relationship and shall treat any such * relationship as invalid. - * + *
* @param targetPartName * Name of the target part. This one must be relative to the * source root directory of the part. @@ -281,12 +281,12 @@ public abstract class PackagePart implements RelationshipSource { /** * Add a relationship to a part (except relationships part). - * + ** Check rule M1.25: The Relationships part shall not have relationships to * any other part. Package implementers shall enforce this requirement upon * the attempt to create such a relationship and shall treat any such * relationship as invalid. - * + *
* @param targetURI * URI of the target part. Must be relative to the source root * directory of the part. @@ -572,14 +572,14 @@ public abstract class PackagePart implements RelationshipSource { } /** - * @return + * @return true if this part is a relationship */ public boolean isRelationshipPart() { return this.isRelationshipPart; } /** - * @return + * @return true if this part has been logically deleted */ public boolean isDeleted() { return isDeleted; diff --git a/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartName.java b/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartName.java index 414fd41aa..f1cc7fdaa 100755 --- a/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartName.java +++ b/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartName.java @@ -29,7 +29,7 @@ import org.apache.poi.openxml4j.exceptions.OpenXML4JRuntimeException; * @author Julien Chable * @version 0.1 * - * @see http://www.ietf.org/rfc/rfc3986.txt + * @see http://www.ietf.org/rfc/rfc3986.txt */ public final class PackagePartName implements Comparable* Check rule M1.25: The Relationships part shall not have relationships to * any other part. Package implementers shall enforce this requirement upon * the attempt to create such a relationship and shall treat any such * relationship as invalid. - * + *
* @param targetPartName * Name of the target part. This one must be relative to the * source root directory of the part. diff --git a/src/ooxml/java/org/apache/poi/openxml4j/opc/ZipPackage.java b/src/ooxml/java/org/apache/poi/openxml4j/opc/ZipPackage.java index 4f463e0df..f3e9a578c 100755 --- a/src/ooxml/java/org/apache/poi/openxml4j/opc/ZipPackage.java +++ b/src/ooxml/java/org/apache/poi/openxml4j/opc/ZipPackage.java @@ -28,7 +28,6 @@ import java.util.zip.ZipFile; import java.util.zip.ZipInputStream; import java.util.zip.ZipOutputStream; -import org.apache.log4j.Logger; import org.apache.poi.openxml4j.exceptions.InvalidFormatException; import org.apache.poi.openxml4j.exceptions.InvalidOperationException; import org.apache.poi.openxml4j.exceptions.OpenXML4JException; @@ -43,6 +42,8 @@ import org.apache.poi.openxml4j.opc.internal.marshallers.ZipPartMarshaller; import org.apache.poi.openxml4j.util.ZipEntrySource; import org.apache.poi.openxml4j.util.ZipFileZipEntrySource; import org.apache.poi.openxml4j.util.ZipInputStreamZipEntrySource; +import org.apache.poi.util.POILogger; +import org.apache.poi.util.POILogFactory; /** * Physical zip package. @@ -52,7 +53,7 @@ import org.apache.poi.openxml4j.util.ZipInputStreamZipEntrySource; */ public final class ZipPackage extends Package { - private static Logger logger = Logger.getLogger("org.openxml4j"); + private static POILogger logger = POILogFactory.getLogger(ZipPackage.class); /** * Zip archive, as either a file on disk, @@ -220,7 +221,7 @@ public final class ZipPackage extends Package { } } catch (Exception e) { // We assume we can continue, even in degraded mode ... - logger.warn("Entry " + logger.log(POILogger.WARN,"Entry " + entry.getName() + " is not valid, so this part won't be add to the package."); return null; @@ -308,7 +309,7 @@ public final class ZipPackage extends Package { // temporary file if (!tempFile.delete()) { logger - .warn("The temporary file: '" + .log(POILogger.WARN,"The temporary file: '" + targetFile.getAbsolutePath() + "' cannot be deleted ! Make sure that no other application use it."); } @@ -353,7 +354,7 @@ public final class ZipPackage extends Package { * current package * * - * @see #getPart(URI) + * @see #getPart(PackageRelationship) */ @Override protected PackagePart getPartImpl(PackagePartName partName) { @@ -371,7 +372,6 @@ public final class ZipPackage extends Package { * The stream use to save this package. * * @see #save(OutputStream) - * @see #saveInZip(ZipOutputStream) */ @Override public void saveImpl(OutputStream outputStream) { @@ -389,7 +389,7 @@ public final class ZipPackage extends Package { // we save it as well if (this.getPartsByRelationshipType( PackageRelationshipTypes.CORE_PROPERTIES).size() == 0) { - logger.debug("Save core properties part"); + logger.log(POILogger.DEBUG,"Save core properties part"); // We have to save the core properties part ... new ZipPackagePropertiesMarshaller().marshall( @@ -408,13 +408,13 @@ public final class ZipPackage extends Package { } // Save package relationships part. - logger.debug("Save package relationships"); + logger.log(POILogger.DEBUG,"Save package relationships"); ZipPartMarshaller.marshallRelationshipPart(this.getRelationships(), PackagingURIHelper.PACKAGE_RELATIONSHIPS_ROOT_PART_NAME, zos); // Save content type part. - logger.debug("Save content types part"); + logger.log(POILogger.DEBUG,"Save content types part"); this.contentTypeManager.save(zos); // Save parts. @@ -424,7 +424,7 @@ public final class ZipPackage extends Package { if (part.isRelationshipPart()) continue; - logger.debug("Save part '" + logger.log(POILogger.DEBUG,"Save part '" + ZipHelper.getZipItemNameFromOPCName(part .getPartName().getName()) + "'"); PartMarshaller marshaller = partMarshallers @@ -449,7 +449,7 @@ public final class ZipPackage extends Package { zos.close(); } catch (Exception e) { logger - .error("Fail to save: an error occurs while saving the package : " + .log(POILogger.ERROR,"Fail to save: an error occurs while saving the package : " + e.getMessage()); } } diff --git a/src/ooxml/java/org/apache/poi/openxml4j/opc/internal/ContentType.java b/src/ooxml/java/org/apache/poi/openxml4j/opc/internal/ContentType.java index 18a6ca4ab..5f40940b4 100755 --- a/src/ooxml/java/org/apache/poi/openxml4j/opc/internal/ContentType.java +++ b/src/ooxml/java/org/apache/poi/openxml4j/opc/internal/ContentType.java @@ -25,28 +25,28 @@ import java.util.regex.Pattern; import org.apache.poi.openxml4j.exceptions.InvalidFormatException; /** - * Represents a immutable MIME ContentType value (RFC 2616 �3.7) - * + * Represents a immutable MIME ContentType value (RFC 2616 §3.7) + *
* media-type = type "/" subtype *( ";" parameter ) type = token
* subtype = token
- *
+ *
* Rule M1.13 : Package implementers shall only create and only recognize parts * with a content type; format designers shall specify a content type for each * part included in the format. Content types for package parts shall fit the - * definition and syntax for media types as specified in RFC 2616,��3.7. - * + * definition and syntax for media types as specified in RFC 2616, \§3.7. + *
* Rule M1.14: Content types shall not use linear white space either between the * type and subtype or between an attribute and its value. Content types also * shall not have leading or trailing white spaces. Package implementers shall * create only such content types and shall require such content types when * retrieving a part from a package; format designers shall specify only such * content types for inclusion in the format. - * + *
* @author Julien Chable * @version 0.1 * - * @see http://www.ietf.org/rfc/rfc2045.txt - * @see http://www.ietf.org/rfc/rfc2616.txt + * @see http://www.ietf.org/rfc/rfc2045.txt + * @see http://www.ietf.org/rfc/rfc2616.txt */ public final class ContentType { diff --git a/src/ooxml/java/org/apache/poi/openxml4j/opc/internal/ContentTypeManager.java b/src/ooxml/java/org/apache/poi/openxml4j/opc/internal/ContentTypeManager.java index 5f96d180e..927102d6d 100755 --- a/src/ooxml/java/org/apache/poi/openxml4j/opc/internal/ContentTypeManager.java +++ b/src/ooxml/java/org/apache/poi/openxml4j/opc/internal/ContentTypeManager.java @@ -27,7 +27,6 @@ import java.util.TreeMap; import java.util.Map.Entry; import java.util.zip.ZipOutputStream; -import org.apache.log4j.Logger; import org.dom4j.Document; import org.dom4j.DocumentException; import org.dom4j.DocumentHelper; @@ -42,6 +41,8 @@ import org.apache.poi.openxml4j.opc.Package; import org.apache.poi.openxml4j.opc.PackagePart; import org.apache.poi.openxml4j.opc.PackagePartName; import org.apache.poi.openxml4j.opc.PackagingURIHelper; +import org.apache.poi.util.POILogger; +import org.apache.poi.util.POILogFactory; /** * Manage package content types ([Content_Types].xml part). @@ -51,7 +52,7 @@ import org.apache.poi.openxml4j.opc.PackagingURIHelper; */ public abstract class ContentTypeManager { - protected static Logger logger = Logger.getLogger("org.openxml4j"); + private static POILogger logger = POILogFactory.getLogger(ContentTypeManager.class); /** * Reference to the package using this content type manager. @@ -95,7 +96,7 @@ public abstract class ContentTypeManager { /** * Constructor. Parses the content of the specified input stream. * - * @param archive + * @param in * If different of null then the content types part is * retrieve and parse. * @throws InvalidFormatException @@ -118,43 +119,39 @@ public abstract class ContentTypeManager { /** * Build association extention-> content type (will be stored in * [Content_Types].xml) for example ContentType="image/png" Extension="png" - * + ** [M2.8]: When adding a new part to a package, the package implementer * shall ensure that a content type for that part is specified in the * Content Types stream; the package implementer shall perform the steps - * described in��9.1.2.3: - * + * described in §9.1.2.3: + *
* 1. Get the extension from the part name by taking the substring to the * right of the rightmost occurrence of the dot character (.) from the * rightmost segment. - * + *
* 2. If a part name has no extension, a corresponding Override element * shall be added to the Content Types stream. - * + *
* 3. Compare the resulting extension with the values specified for the * Extension attributes of the Default elements in the Content Types stream. * The comparison shall be case-insensitive ASCII. - * + *
* 4. If there is a Default element with a matching Extension attribute, * then the content type of the new part shall be compared with the value of * the ContentType attribute. The comparison might be case-sensitive and * include every character regardless of the role it plays in the * content-type grammar of RFC 2616, or it might follow the grammar of RFC * 2616. - * + *
* a. If the content types match, no further action is required. - * + *
* b. If the content types do not match, a new Override element shall be * added to the Content Types stream. . - * + *
* 5. If there is no Default element with a matching Extension attribute, a * new Default element or Override element shall be added to the Content * Types stream. - * - * - * @param partUri - * the uri that will be stored - * @return false if an error occured. + *
*/ public void addContentType(PackagePartName partName, String contentType) { boolean defaultCTExists = false; @@ -197,18 +194,19 @@ public abstract class ContentTypeManager { } /** + ** Delete a content type based on the specified part name. If the specified * part name is register with an override content type, then this content * type is remove, else the content type is remove in the default content * type list if it exists and if no part is associated with it yet. - * + *
* Check rule M2.4: The package implementer shall require that the Content * Types stream contain one of the following for every part in the package: * One matching Default element One matching Override element Both a * matching Default element and a matching Override element, in which case * the Override element takes precedence. - * - * @param partUri + *
+ * @param partName * The part URI associated with the override content type to * delete. * @exception InvalidOperationException @@ -290,34 +288,34 @@ public abstract class ContentTypeManager { /** * Get the content type for the specified part, if any. - * + ** Rule [M2.9]: To get the content type of a part, the package implementer - * shall perform the steps described in��9.1.2.4: - * + * shall perform the steps described in §9.1.2.4: + *
* 1. Compare the part name with the values specified for the PartName * attribute of the Override elements. The comparison shall be * case-insensitive ASCII. - * + *
* 2. If there is an Override element with a matching PartName attribute, * return the value of its ContentType attribute. No further action is * required. - * + *
* 3. If there is no Override element with a matching PartName attribute, * then a. Get the extension from the part name by taking the substring to * the right of the rightmost occurrence of the dot character (.) from the * rightmost segment. b. Check the Default elements of the Content Types * stream, comparing the extension with the value of the Extension * attribute. The comparison shall be case-insensitive ASCII. - * + *
* 4. If there is a Default element with a matching Extension attribute, * return the value of its ContentType attribute. No further action is * required. - * + *
* 5. If neither Override nor Default elements with matching attributes are * found for the specified part name, the implementation shall not map this * part name to a part. - * - * @param partUri + *
+ * @param partName * The URI part to check. * @return The content type associated with the URI (in case of an override * content type) or the extension (in case of default content type), @@ -460,7 +458,7 @@ public abstract class ContentTypeManager { * XML parent element use to append this override type element. * @param entry * The values to append. - * @see #save(ZipOutputStream) + * @see #save(java.io.OutputStream) */ private void appendSpecificTypes(Element root, Entry* Rule M4.2: A format consumer shall consider the use of the Markup * Compatibility namespace to be an error. - * + *
* Rule M4.3: Producers shall not create a document element that contains
* refinements to the Dublin Core elements, except for the two specified in
* the schema:
* Rule M4.4: Producers shall not create a document element that contains * the xml:lang attribute. Consumers shall consider a document element that * violates this constraint to be an error. - * + *
* Rule M4.5: Producers shall not create a document element that contains
* the xsi:type attribute, except for a