HPSF

Abbreviates a String using ellipses. This will turn + * "Now is the time for all good men" into "Now is the time for..."

Abbreviates a String using ellipses. This will turn + * "Now is the time for all good men" into "...is the time for..."

Works like {@code abbreviate(String, int)}, but allows you to specify + * a "left edge" offset. Note that this left edge is not necessarily going to + * be the leftmost character in the result, or the first character following the + * ellipses, but it will appear somewhere in the result. + * + *

Abbreviates a String to the length passed, replacing the middle characters with the supplied + * replacement String.

Compares two Strings, and returns the portion where they differ. + * (More precisely, return the remainder of the second String, + * starting from where it's different from the first.)

For example, + * {@code difference("i am a machine", "i am a robot") -> "robot"}.

Compares two CharSequences, and returns the index at which the + * CharSequences begin to differ.

For example, + * {@code indexOfDifference("i am a machine", "i am a robot") -> 7}

Compares all CharSequences in an array and returns the index at which the + * CharSequences begin to differ.

For example, + * indexOfDifference(new String[] {"i am a machine", "i am a robot"}) -> 7

Compares all Strings in an array and returns the initial sequence of + * characters that is common to all of them.

For example, + * getCommonPrefix(new String[] {"i am a machine", "i am a robot"}) -> "i am a "

This is the number of changes needed to change one String into + * another, where each change is a single character modification (deletion, + * insertion or substitution).

Chas Emerick has written an implementation in Java, which avoids an OutOfMemoryError + * which can occur when my Java implementation is used with very large strings.
+ * This implementation of the Levenshtein distance algorithm + * is from http://www.merriampark.com/ldjava.htm

Find the Levenshtein distance between two Strings if it's less than or equal to a given + * threshold.

This is the number of changes needed to change one String into + * another, where each change is a single character modification (deletion, + * insertion or substitution).

This implementation follows from Algorithms on Strings, Trees and Sequences by Dan Gusfield + * and Chas Emerick's implementation of the Levenshtein distance algorithm from + * http://www.merriampark.com/ld.htm

{@code null}s are handled without exceptions. Two {@code null} + * references are considered to be equal. The comparison is case sensitive.

{@code null}s are handled without exceptions. Two {@code null} + * references are considered to be equal. The comparison is case insensitive.

Check if a CharSequence starts with a specified prefix (optionally case insensitive).

{@code null}s are handled without exceptions. Two {@code null} + * references are considered to be equal. The comparison is case sensitive.

{@code null}s are handled without exceptions. Two {@code null} + * references are considered to be equal. The comparison is case insensitive.

Check if a CharSequence ends with a specified suffix (optionally case insensitive).

+ * The function returns the argument string with whitespace normalized by using + * {@link #trim(String)} to remove leading and trailing whitespace + * and then replacing sequences of whitespace characters by a single space. + *

+ * The difference is that Java's whitespace includes vertical tab and form feed, which this functional will also + * normalize. Additionally {@link #trim(String)} removes control characters (char <= 32) from both + * ends of this String. + *

+ * If a system property cannot be read due to security restrictions, the corresponding field in this class will be set + * to {@code null} and a message will be written to {@code System.err}. + *

+ * The {@code line.separator} System Property. Line separator ("\n" on UNIX). + *

+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does + * not exist. + *

+ * This value is initialized when the class is loaded. If {@link System#setProperty(String,String)} or + * {@link System#setProperties(java.util.Properties)} is called after this class is loaded, the value will be out of + * sync with that System property. + *

+ * Gets a System property, defaulting to {@code null} if the property cannot be read. + *

+ * If a {@code SecurityException} is caught, the return value is {@code null} and a message is written to + * {@code System.err}. + *

+ * SystemUtils instances should NOT be constructed in standard programming. Instead, the class should be used as + * {@code SystemUtils.FILE_SEPARATOR}. + *

+ * This constructor is public to permit tools that require a JavaBean instance to operate. + *

Most of these classes are immutable and thus thread-safe. +However Charset is not currently guaranteed thread-safe under all circumstances.

This class tries to handle null input gracefully. + * An exception will not be thrown for a null input. + * Each method documents its behaviour in more detail.

WordUtils instances should NOT be constructed in + * standard programming. Instead, the class should be used as + * WordUtils.wrap("foo bar", 20);.

This constructor is public to permit tools that require a JavaBean + * instance to operate.

New lines will be separated by the system property line separator. + * Very long words, such as URLs will not be wrapped.

Leading spaces on a new line are stripped. + * Trailing spaces are not stripped.

Capitalizes all the whitespace separated words in a String. + * Only the first letter of each word is changed. To convert the + * rest of each word to lowercase at the same time, + * use {@link #capitalizeFully(String)}.

Whitespace is defined by {@link Character#isWhitespace(char)}. + * A null input String returns null. + * Capitalization uses the Unicode title case, normally equivalent to + * upper case.

Capitalizes all the delimiter separated words in a String. + * Only the first letter of each word is changed. To convert the + * rest of each word to lowercase at the same time, + * use {@link #capitalizeFully(String, char[])}.

The delimiters represent a set of characters understood to separate words. + * The first string character and the first non-delimiter character after a + * delimiter will be capitalized.

A null input String returns null. + * Capitalization uses the Unicode title case, normally equivalent to + * upper case.

Converts all the whitespace separated words in a String into capitalized words, + * that is each word is made up of a titlecase character and then a series of + * lowercase characters.

Whitespace is defined by {@link Character#isWhitespace(char)}. + * A null input String returns null. + * Capitalization uses the Unicode title case, normally equivalent to + * upper case.

Converts all the delimiter separated words in a String into capitalized words, + * that is each word is made up of a titlecase character and then a series of + * lowercase characters.

The delimiters represent a set of characters understood to separate words. + * The first string character and the first non-delimiter character after a + * delimiter will be capitalized.

A null input String returns null. + * Capitalization uses the Unicode title case, normally equivalent to + * upper case.

Uncapitalizes all the whitespace separated words in a String. + * Only the first letter of each word is changed.

Whitespace is defined by {@link Character#isWhitespace(char)}. + * A null input String returns null.

Uncapitalizes all the whitespace separated words in a String. + * Only the first letter of each word is changed.

The delimiters represent a set of characters understood to separate words. + * The first string character and the first non-delimiter character after a + * delimiter will be uncapitalized.

Whitespace is defined by {@link Character#isWhitespace(char)}. + * A null input String returns null.

The first letter of the string and all first letters after + * whitespace are returned as a new string. + * Their case is not changed.

Whitespace is defined by {@link Character#isWhitespace(char)}. + * A null input String returns null.

The first letter of the string and all first letters after the + * defined delimiters are returned as a new string. + * Their case is not changed.

If the delimiters array is null, then Whitespace is used. + * Whitespace is defined by {@link Character#isWhitespace(char)}. + * A null input String returns null. + * An empty delimiter array returns an empty String.

+Provides classes for handling and manipulating text, partly as an extension to {@link java.text}. +The classes in this package are, for the most part, intended to be instantiated. +(ie. they are not utility classes with lots of static methods) +

Represents a class ID (16 bytes). Unlike other little-endian + * type the {@link ClassID} is not just 16 bytes stored in the wrong + * order. Instead, it is a double word (4 bytes) followed by two + * words (2 bytes each) followed by 8 bytes.

Gets the bytes making out the class ID. They are returned in + * correct order, i.e. big-endian.

Reads the class ID's value from a byte array by turning + * little-endian into big-endian.

Returns a human-readable representation of the Class ID in standard + * format "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}".

Codepage for Macintosh Chinese Traditional (Java: unknown - use Big5, + * MS950, or cp937)

Codepage for Macintosh Chinese Simplified (Java: unknown - use + * EUC_CN, ISO2022_CN_GB, MS936 or cp935)

Convenience class representing a DocumentSummary Information stream in a + * Microsoft Office document.

The document name a document summary information stream + * usually has in a POIFS filesystem.

Creates a {@link DocumentSummaryInformation} from a given + * {@link PropertySet}.

This exception is the superclass of all other checked exceptions thrown + * in this package. It supports a nested "reason" throwable, i.e. an exception + * that caused this one to be thrown.

This exception is the superclass of all other unchecked + * exceptions thrown in this package. It supports a nested "reason" + * throwable, i.e. an exception that caused this one to be thrown.

Returns the {@link Throwable} that caused this exception to + * be thrown or null if there was no such {@link + * Throwable}.

This exception is thrown when there is an illegal value set in a + * {@link PropertySet}. For example, a {@link Variant#VT_BOOL} must + * have a value of -1 (true) or 0 (false). + * Any other value would trigger this exception. It supports a nested + * "reason" throwable, i.e. an exception that caused this one to be + * thrown.

This exception is thrown if an {@link java.io.InputStream} does + * not support the {@link java.io.InputStream#mark} operation.

This exception is thrown if one of the {@link PropertySet}'s + * convenience methods does not find a required {@link Section}.

The constructors of this class are analogous to those of its + * superclass and documented there.

Please be aware that this class' functionality will be merged into the + * {@link Property} class at a later time, so the API will change.

Creates an empty property. It must be filled using the set method to + * be usable.

Please be aware that this class' functionality will be merged into the + * {@link PropertySet} class at a later time, so the API will change.

Constructs a MutablePropertySet instance. Its + * primary task is to initialize the immutable field with their proper + * values. It also sets fields that might change to reasonable defaults.

(); + sections.add(new MutableSection()); + } + + + + /** + *

Constructs a MutablePropertySet by doing a deep copy of + * an existing PropertySet. All nested elements, i.e. + * Sections and Property instances, will be their + * mutable counterparts in the new MutablePropertySet.

+ * + * @param ps The property set to copy + */ + public MutablePropertySet(final PropertySet ps) + { + byteOrder = ps.getByteOrder(); + format = ps.getFormat(); + osVersion = ps.getOSVersion(); + setClassID(ps.getClassID()); + clearSections(); + if (sections == null) + sections = new LinkedList

(); + for (final Iterator

i = ps.getSections().iterator(); i.hasNext();) + { + addSection(new MutableSection(i.next())); + } + } + + + + /** + *

The length of the property set stream header.

+ */ + private final int OFFSET_HEADER = + BYTE_ORDER_ASSERTION.length + /* Byte order */ + FORMAT_ASSERTION.length + /* Format */ + LittleEndianConsts.INT_SIZE + /* OS version */ + ClassID.LENGTH + /* Class ID */ + LittleEndianConsts.INT_SIZE; /* Section count */ + + + + /** + *

Sets the "byteOrder" property.

+ * + * @param byteOrder the byteOrder value to set + */ + public void setByteOrder(final int byteOrder) + { + this.byteOrder = byteOrder; + } + + + + /** + *

Sets the "format" property.

+ * + * @param format the format value to set + */ + public void setFormat(final int format) + { + this.format = format; + } + + + + /** + *

Sets the "osVersion" property.

+ * + * @param osVersion the osVersion value to set + */ + public void setOSVersion(final int osVersion) + { + this.osVersion = osVersion; + } + + + + /** + *

Sets the property set stream's low-level "class ID" + * field.

+ * + * @param classID The property set stream's low-level "class ID" field. + * + * @see PropertySet#getClassID() + */ + public void setClassID(final ClassID classID) + { + this.classID = classID; + } + + + + /** + *

Removes all sections from this property set.

+ */ + public void clearSections() + { + sections = null; + } + + + + /** + *

Adds a section to this property set.

+ * + * @param section The {@link Section} to add. It will be appended + * after any sections that are already present in the property set + * and thus become the last section. + */ + public void addSection(final Section section) + { + if (sections == null) + sections = new LinkedList

(); + sections.add(section); + } + + + + /** + *

Writes the property set to an output stream.

+ * + * @param out the output stream to write the section to + * @exception IOException if an error when writing to the output stream + * occurs + * @exception WritingNotSupportedException if HPSF does not yet support + * writing a property's variant type. + */ + public void write(final OutputStream out) + throws WritingNotSupportedException, IOException + { + /* Write the number of sections in this property set stream. */ + final int nrSections = sections.size(); + //int length = 0; + + /* Write the property set's header. */ + /*length +=*/ TypeWriter.writeToStream(out, (short) getByteOrder()); + /*length +=*/ TypeWriter.writeToStream(out, (short) getFormat()); + /*length +=*/ TypeWriter.writeToStream(out, getOSVersion()); + /*length +=*/ TypeWriter.writeToStream(out, getClassID()); + /*length +=*/ TypeWriter.writeToStream(out, nrSections); + int offset = OFFSET_HEADER; + + /* Write the section list, i.e. the references to the sections. Each + * entry in the section list consist of the section's class ID and the + * section's offset relative to the beginning of the stream. */ + offset += nrSections * (ClassID.LENGTH + LittleEndian.INT_SIZE); + final int sectionsBegin = offset; + for (final ListIterator

i = sections.listIterator(); i.hasNext();) + { + final MutableSection s = (MutableSection) i.next(); + final ClassID formatID = s.getFormatID(); + if (formatID == null) + throw new NoFormatIDException(); + /*length +=*/ TypeWriter.writeToStream(out, s.getFormatID()); + /*length +=*/ TypeWriter.writeUIntToStream(out, offset); + try + { + offset += s.getSize(); + } + catch (HPSFRuntimeException ex) + { + final Throwable cause = ex.getReason(); + if (cause instanceof UnsupportedEncodingException) { + throw new IllegalPropertySetDataException(cause); + } + throw ex; + } + } + + /* Write the sections themselves. */ + offset = sectionsBegin; + for (final ListIterator

i = sections.listIterator(); i.hasNext();) + { + final MutableSection s = (MutableSection) i.next(); + offset += s.write(out); + } + } + + + + /** + *

Returns the contents of this property set stream as an input stream. + * The latter can be used for example to write the property set into a POIFS + * document. The input stream represents a snapshot of the property set. + * If the latter is modified while the input stream is still being + * read, the modifications will not be reflected in the input stream but in + * the {@link MutablePropertySet} only.

+ * + * @return the contents of this property set stream + * + * @throws WritingNotSupportedException if HPSF does not yet support writing + * of a property's variant type. + * @throws IOException if an I/O exception occurs. + */ + public InputStream toInputStream() + throws IOException, WritingNotSupportedException + { + final ByteArrayOutputStream psStream = new ByteArrayOutputStream(); + write(psStream); + psStream.close(); + final byte[] streamData = psStream.toByteArray(); + return new ByteArrayInputStream(streamData); + } + + /** + *

Writes a property set to a document in a POI filesystem directory.

+ * + * @param dir The directory in the POI filesystem to write the document to. + * @param name The document's name. If there is already a document with the + * same name in the directory the latter will be overwritten. + * + * @throws WritingNotSupportedException + * @throws IOException + */ + public void write(final DirectoryEntry dir, final String name) + throws WritingNotSupportedException, IOException + { + /* If there is already an entry with the same name, remove it. */ + try + { + final Entry e = dir.getEntry(name); + e.delete(); + } + catch (FileNotFoundException ex) + { + /* Entry not found, no need to remove it. */ + } + /* Create the new entry. */ + dir.createDocument(name, toInputStream()); + } + +} Index: /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/MutableSection.java =================================================================== --- /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/MutableSection.java (revision 28000) +++ /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/MutableSection.java (revision 28000) @@ -0,0 +1,533 @@ +/* ==================================================================== + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +==================================================================== */ + +package org.apache.poi.hpsf; + +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.io.OutputStream; +import java.util.Collections; +import java.util.Comparator; +import java.util.Iterator; +import java.util.LinkedList; +import java.util.List; +import java.util.ListIterator; +import java.util.Map; + +import org.apache.poi.hpsf.wellknown.PropertyIDMap; +import org.apache.poi.util.LittleEndian; + +/** + *

Adds writing capability to the {@link Section} class.

+ * + *

Please be aware that this class' functionality will be merged into the + * {@link Section} class at a later time, so the API will change.

+ */ +public class MutableSection extends Section +{ + /** + *

If the "dirty" flag is true, the section's size must be + * (re-)calculated before the section is written.

+ */ + private boolean dirty = true; + + + + /** + *

List to assemble the properties. Unfortunately a wrong + * decision has been taken when specifying the "properties" field + * as an Property[]. It should have been a {@link java.util.List}.

+ */ + private List preprops; + + + + /** + *

Contains the bytes making out the section. This byte array is + * established when the section's size is calculated and can be reused + * later. It is valid only if the "dirty" flag is false.

+ */ + private byte[] sectionBytes; + + + + /** + *

Creates an empty mutable section.

+ */ + public MutableSection() + { + dirty = true; + formatID = null; + offset = -1; + preprops = new LinkedList(); + } + + + + /** + *

Constructs a MutableSection by doing a deep copy of an + * existing Section. All nested Property + * instances, will be their mutable counterparts in the new + * MutableSection.

+ * + * @param s The section set to copy + */ + public MutableSection(final Section s) + { + setFormatID(s.getFormatID()); + final Property[] pa = s.getProperties(); + final MutableProperty[] mpa = new MutableProperty[pa.length]; + for (int i = 0; i < pa.length; i++) + mpa[i] = new MutableProperty(pa[i]); + setProperties(mpa); + setDictionary(s.getDictionary()); + } + + + + /** + *

Sets the section's format ID.

+ * + * @param formatID The section's format ID + * + * @see #setFormatID(byte[]) + * @see Section#getFormatID + */ + public void setFormatID(final ClassID formatID) + { + this.formatID = formatID; + } + + + + + /** + *

Sets this section's properties. Any former values are overwritten.

+ * + * @param properties This section's new properties. + */ + public void setProperties(final Property[] properties) + { + this.properties = properties; + preprops = new LinkedList(); + for (int i = 0; i < properties.length; i++) + preprops.add(properties[i]); + dirty = true; + } + + + /** + *

Sets the value and the variant type of the property with the + * specified ID. If a property with this ID is not yet present in + * the section, it will be added. An already present property with + * the specified ID will be overwritten. A default mapping will be + * used to choose the property's type.

+ * + * @param id The property's ID. + * @param variantType The property's variant type. + * @param value The property's value. + * + * @see #setProperty(int, String) + * @see #getProperty + * @see Variant + */ + public void setProperty(final int id, final long variantType, + final Object value) + { + final MutableProperty p = new MutableProperty(); + p.setID(id); + p.setType(variantType); + p.setValue(value); + setProperty(p); + dirty = true; + } + + + + /** + *

Sets a property.

+ * + * @param p The property to be set. + * + * @see #setProperty(int, long, Object) + * @see #getProperty + * @see Variant + */ + public void setProperty(final Property p) + { + final long id = p.getID(); + removeProperty(id); + preprops.add(p); + dirty = true; + } + + + + /** + *

Removes a property.

+ * + * @param id The ID of the property to be removed + */ + public void removeProperty(final long id) + { + for (final Iterator i = preprops.iterator(); i.hasNext();) + if (i.next().getID() == id) + { + i.remove(); + break; + } + dirty = true; + } + + + /** + *

Returns the section's size.

+ * + * @return the section's size. + */ + public int getSize() + { + if (dirty) + { + try + { + size = calcSize(); + dirty = false; + } + catch (HPSFRuntimeException ex) + { + throw ex; + } + catch (Exception ex) + { + throw new HPSFRuntimeException(ex); + } + } + return size; + } + + + + /** + *

Calculates the section's size. It is the sum of the lengths of the + * section's header (8), the properties list (16 times the number of + * properties) and the properties themselves.

+ * + * @return the section's length in bytes. + * @throws WritingNotSupportedException + * @throws IOException + */ + private int calcSize() throws WritingNotSupportedException, IOException + { + final ByteArrayOutputStream out = new ByteArrayOutputStream(); + write(out); + out.close(); + /* Pad to multiple of 4 bytes so that even the Windows shell (explorer) + * shows custom properties. */ + sectionBytes = Util.pad4(out.toByteArray()); + return sectionBytes.length; + } + + + + /** + *

Writes this section into an output stream.

+ * + *

Internally this is done by writing into three byte array output + * streams: one for the properties, one for the property list and one for + * the section as such. The two former are appended to the latter when they + * have received all their data.

+ * + * @param out The stream to write into. + * + * @return The number of bytes written, i.e. the section's size. + * @exception IOException if an I/O error occurs + * @exception WritingNotSupportedException if HPSF does not yet support + * writing a property's variant type. + */ + public int write(final OutputStream out) + throws WritingNotSupportedException, IOException + { + /* Check whether we have already generated the bytes making out the + * section. */ + if (!dirty && sectionBytes != null) + { + out.write(sectionBytes); + return sectionBytes.length; + } + + /* The properties are written to this stream. */ + final ByteArrayOutputStream propertyStream = + new ByteArrayOutputStream(); + + /* The property list is established here. After each property that has + * been written to "propertyStream", a property list entry is written to + * "propertyListStream". */ + final ByteArrayOutputStream propertyListStream = + new ByteArrayOutputStream(); + + /* Maintain the current position in the list. */ + int position = 0; + + /* Increase the position variable by the size of the property list so + * that it points behind the property list and to the beginning of the + * properties themselves. */ + position += 2 * LittleEndian.INT_SIZE + + getPropertyCount() * 2 * LittleEndian.INT_SIZE; + + /* Writing the section's dictionary it tricky. If there is a dictionary + * (property 0) the codepage property (property 1) must be set, too. */ + int codepage = -1; + if (getProperty(PropertyIDMap.PID_DICTIONARY) != null) + { + final Object p1 = getProperty(PropertyIDMap.PID_CODEPAGE); + if (p1 != null) + { + if (!(p1 instanceof Integer)) + throw new IllegalPropertySetDataException + ("The codepage property (ID = 1) must be an " + + "Integer object."); + } + else + /* Warning: The codepage property is not set although a + * dictionary is present. In order to cope with this problem we + * add the codepage property and set it to Unicode. */ + setProperty(PropertyIDMap.PID_CODEPAGE, Variant.VT_I2, + Integer.valueOf(Constants.CP_UNICODE)); + codepage = getCodepage(); + } + + /* Sort the property list by their property IDs: */ + Collections.sort(preprops, new Comparator() + { + public int compare(final Property p1, final Property p2) + { + if (p1.getID() < p2.getID()) + return -1; + else if (p1.getID() == p2.getID()) + return 0; + else + return 1; + } + }); + + /* Write the properties and the property list into their respective + * streams: */ + for (final ListIterator i = preprops.listIterator(); i.hasNext();) + { + final MutableProperty p = (MutableProperty) i.next(); + final long id = p.getID(); + + /* Write the property list entry. */ + TypeWriter.writeUIntToStream(propertyListStream, p.getID()); + TypeWriter.writeUIntToStream(propertyListStream, position); + + /* If the property ID is not equal 0 we write the property and all + * is fine. However, if it equals 0 we have to write the section's + * dictionary which has an implicit type only and an explicit + * value. */ + if (id != 0) + /* Write the property and update the position to the next + * property. */ + position += p.write(propertyStream, getCodepage()); + else + { + if (codepage == -1) + throw new IllegalPropertySetDataException + ("Codepage (property 1) is undefined."); + position += writeDictionary(propertyStream, dictionary, + codepage); + } + } + propertyStream.close(); + propertyListStream.close(); + + /* Write the section: */ + byte[] pb1 = propertyListStream.toByteArray(); + byte[] pb2 = propertyStream.toByteArray(); + + /* Write the section's length: */ + TypeWriter.writeToStream(out, LittleEndian.INT_SIZE * 2 + + pb1.length + pb2.length); + + /* Write the section's number of properties: */ + TypeWriter.writeToStream(out, getPropertyCount()); + + /* Write the property list: */ + out.write(pb1); + + /* Write the properties: */ + out.write(pb2); + + int streamLength = LittleEndian.INT_SIZE * 2 + pb1.length + pb2.length; + return streamLength; + } + + + + /** + *

Writes the section's dictionary.

+ * + * @param out The output stream to write to. + * @param dictionary The dictionary. + * @param codepage The codepage to be used to write the dictionary items. + * @return The number of bytes written + * @exception IOException if an I/O exception occurs. + */ + private static int writeDictionary(final OutputStream out, + final Map dictionary, final int codepage) + throws IOException + { + int length = TypeWriter.writeUIntToStream(out, dictionary.size()); + for (final Iterator i = dictionary.keySet().iterator(); i.hasNext();) + { + final Long key = i.next(); + final String value = dictionary.get(key); + + if (codepage == Constants.CP_UNICODE) + { + /* Write the dictionary item in Unicode. */ + int sLength = value.length() + 1; + if (sLength % 2 == 1) + sLength++; + length += TypeWriter.writeUIntToStream(out, key.longValue()); + length += TypeWriter.writeUIntToStream(out, sLength); + final byte[] ca = + value.getBytes(VariantSupport.codepageToEncoding(codepage)); + for (int j = 2; j < ca.length; j += 2) + { + out.write(ca[j+1]); + out.write(ca[j]); + length += 2; + } + sLength -= value.length(); + while (sLength > 0) + { + out.write(0x00); + out.write(0x00); + length += 2; + sLength--; + } + } + else + { + /* Write the dictionary item in another codepage than + * Unicode. */ + length += TypeWriter.writeUIntToStream(out, key.longValue()); + length += TypeWriter.writeUIntToStream(out, value.length() + 1); + final byte[] ba = + value.getBytes(VariantSupport.codepageToEncoding(codepage)); + for (int j = 0; j < ba.length; j++) + { + out.write(ba[j]); + length++; + } + out.write(0x00); + length++; + } + } + return length; + } + + + + /** + *

Overwrites the super class' method to cope with a redundancy: + * the property count is maintained in a separate member variable, but + * shouldn't.

+ * + * @return The number of properties in this section + */ + public int getPropertyCount() + { + return preprops.size(); + } + + + + /** + *

Gets this section's properties.

+ * + * @return this section's properties. + */ + public Property[] getProperties() + { + properties = preprops.toArray(new Property[0]); + return properties; + } + + + + /** + *

Gets a property.

+ * + * @param id The ID of the property to get + * @return The property or null if there is no such property + */ + public Object getProperty(final long id) + { + /* Calling getProperties() ensures that properties and preprops are in + * sync.

*/ + getProperties(); + return super.getProperty(id); + } + + + + /** + *

Sets the section's dictionary. All keys in the dictionary must be + * {@link java.lang.Long} instances, all values must be + * {@link java.lang.String}s. This method overwrites the properties with IDs + * 0 and 1 since they are reserved for the dictionary and the dictionary's + * codepage. Setting these properties explicitly might have surprising + * effects. An application should never do this but always use this + * method.

+ * + * @param dictionary The dictionary + * + * @exception IllegalPropertySetDataException if the dictionary's key and + * value types are not correct. + * + * @see Section#getDictionary() + */ + public void setDictionary(final Map dictionary) + throws IllegalPropertySetDataException + { + if (dictionary != null) + { + this.dictionary = dictionary; + + /* Set the dictionary property (ID 0). Please note that the second + * parameter in the method call below is unused because dictionaries + * don't have a type. */ + setProperty(PropertyIDMap.PID_DICTIONARY, -1, dictionary); + + /* If the codepage property (ID 1) for the strings (keys and + * values) used in the dictionary is not yet defined, set it to + * Unicode. */ + final Integer codepage = + (Integer) getProperty(PropertyIDMap.PID_CODEPAGE); + if (codepage == null) + setProperty(PropertyIDMap.PID_CODEPAGE, Variant.VT_I2, + Integer.valueOf(Constants.CP_UNICODE)); + } + else + /* Setting the dictionary to null means to remove property 0. + * However, it does not mean to remove property 1 (codepage). */ + removeProperty(PropertyIDMap.PID_DICTIONARY); + } +} Index: /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/NoFormatIDException.java =================================================================== --- /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/NoFormatIDException.java (revision 28000) +++ /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/NoFormatIDException.java (revision 28000) @@ -0,0 +1,41 @@ +/* ==================================================================== + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +==================================================================== */ + +package org.apache.poi.hpsf; + +/** + *

This exception is thrown if a {@link MutablePropertySet} is to be written + * but does not have a formatID set (see {@link + * MutableSection#setFormatID(ClassID)} or + * {@link org.apache.poi.hpsf.MutableSection#setFormatID(byte[])}. + * + * @author Rainer Klute <klute@rainer-klute.de> + */ +@SuppressWarnings("serial") +public class NoFormatIDException extends HPSFRuntimeException +{ + + /** + *

Constructor

+ */ + public NoFormatIDException() + { + super(); + } + +} Index: /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/NoPropertySetStreamException.java =================================================================== --- /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/NoPropertySetStreamException.java (revision 28000) +++ /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/NoPropertySetStreamException.java (revision 28000) @@ -0,0 +1,41 @@ +/* ==================================================================== + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +==================================================================== */ + +package org.apache.poi.hpsf; + +/** + *

This exception is thrown if a format error in a property set stream is + * detected or when the input data do not constitute a property set stream.

+ * + *

The constructors of this class are analogous to those of its superclass + * and are documented there.

+ * + * @author Rainer Klute <klute@rainer-klute.de> + */ +@SuppressWarnings("serial") +public class NoPropertySetStreamException extends HPSFException +{ + + /** + *

Constructor

+ */ + public NoPropertySetStreamException() + { + super(); + } +} Index: /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/NoSingleSectionException.java =================================================================== --- /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/NoSingleSectionException.java (revision 28000) +++ /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/NoSingleSectionException.java (revision 28000) @@ -0,0 +1,44 @@ +/* ==================================================================== + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +==================================================================== */ + +package org.apache.poi.hpsf; + +/** + *

This exception is thrown if one of the {@link PropertySet}'s + * convenience methods that require a single {@link Section} is called + * and the {@link PropertySet} does not contain exactly one {@link + * Section}.

+ * + *

The constructors of this class are analogous to those of its + * superclass and documented there.

+ * + * @author Rainer Klute <klute@rainer-klute.de> + */ +@SuppressWarnings("serial") +public class NoSingleSectionException extends HPSFRuntimeException +{ + + /** + *

Constructor

+ */ + public NoSingleSectionException() + { + super(); + } + +} Index: /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/Property.java =================================================================== --- /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/Property.java (revision 28000) +++ /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/Property.java (revision 28000) @@ -0,0 +1,396 @@ +/* ==================================================================== + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +==================================================================== */ + +package org.apache.poi.hpsf; + +import java.io.UnsupportedEncodingException; +import java.util.HashMap; +import java.util.Map; + +import org.apache.poi.util.HexDump; +import org.apache.poi.util.LittleEndian; +import org.apache.poi.util.POILogFactory; +import org.apache.poi.util.POILogger; + +/** + *

A property in a {@link Section} of a {@link PropertySet}.

+ * + *

The property's ID gives the property a meaning + * in the context of its {@link Section}. Each {@link Section} spans + * its own name space of property IDs.

+ * + *

The property's type determines how its + * value is interpreted. For example, if the type is + * {@link Variant#VT_LPSTR} (byte string), the value consists of a + * DWord telling how many bytes the string contains. The bytes follow + * immediately, including any null bytes that terminate the + * string. The type {@link Variant#VT_I4} denotes a four-byte integer + * value, {@link Variant#VT_FILETIME} some date and time (of a + * file).

+ * + *

Please note that not all {@link Variant} types yet. This might change + * over time but largely depends on your feedback so that the POI team knows + * which variant types are really needed. So please feel free to submit error + * reports or patches for the types you need.

+ * + *

Microsoft documentation: + * Property Set Display Name Dictionary. + * + * @author Rainer Klute <klute@rainer-klute.de> + * @author Drew Varner (Drew.Varner InAndAround sc.edu) + * @see Section + * @see Variant + */ +public class Property +{ + + /**

The property's ID.

*/ + protected long id; + + + /** + *

Returns the property's ID.

+ * + * @return The ID value + */ + public long getID() + { + return id; + } + + + + /**

The property's type.

*/ + protected long type; + + + /** + *

Returns the property's type.

+ * + * @return The type value + */ + public long getType() + { + return type; + } + + + + /**

The property's value.

*/ + protected Object value; + + + /** + *

Returns the property's value.

+ * + * @return The property's value + */ + public Object getValue() + { + return value; + } + + + + /** + *

Creates a property.

+ * + * @param id the property's ID. + * @param type the property's type, see {@link Variant}. + * @param value the property's value. Only certain types are allowed, see + * {@link Variant}. + */ + public Property(final long id, final long type, final Object value) + { + this.id = id; + this.type = type; + this.value = value; + } + + + + /** + *

Creates a {@link Property} instance by reading its bytes + * from the property set stream.

+ * + * @param id The property's ID. + * @param src The bytes the property set stream consists of. + * @param offset The property's type/value pair's offset in the + * section. + * @param length The property's type/value pair's length in bytes. + * @param codepage The section's and thus the property's + * codepage. It is needed only when reading string values. + * @exception UnsupportedEncodingException if the specified codepage is not + * supported. + */ + public Property(final long id, final byte[] src, final long offset, + final int length, final int codepage) + throws UnsupportedEncodingException + { + this.id = id; + + /* + * ID 0 is a special case since it specifies a dictionary of + * property IDs and property names. + */ + if (id == 0) + { + value = readDictionary(src, offset, length, codepage); + return; + } + + int o = (int) offset; + type = LittleEndian.getUInt(src, o); + o += LittleEndian.INT_SIZE; + + try + { + value = VariantSupport.read(src, o, length, (int) type, codepage); + } + catch (UnsupportedVariantTypeException ex) + { + VariantSupport.writeUnsupportedTypeMessage(ex); + value = ex.getValue(); + } + } + + + + /** + *

Creates an empty property. It must be filled using the set method to + * be usable.

+ */ + protected Property() + { } + + + + /** + *

Reads a dictionary.

+ * + * @param src The byte array containing the bytes making out the dictionary. + * @param offset At this offset within src the dictionary + * starts. + * @param length The dictionary contains at most this many bytes. + * @param codepage The codepage of the string values. + * @return The dictonary + * @throws UnsupportedEncodingException if the dictionary's codepage is not + * (yet) supported. + */ + protected Map readDictionary(final byte[] src, final long offset, + final int length, final int codepage) + throws UnsupportedEncodingException + { + /* Check whether "offset" points into the "src" array". */ + if (offset < 0 || offset > src.length) + throw new HPSFRuntimeException + ("Illegal offset " + offset + " while HPSF stream contains " + + length + " bytes."); + int o = (int) offset; + + /* + * Read the number of dictionary entries. + */ + final long nrEntries = LittleEndian.getUInt(src, o); + o += LittleEndian.INT_SIZE; + + final Map m = new HashMap((int) nrEntries, (float) 1.0); + + try + { + for (int i = 0; i < nrEntries; i++) + { + /* The key. */ + final Long id = Long.valueOf(LittleEndian.getUInt(src, o)); + o += LittleEndian.INT_SIZE; + + /* The value (a string). The length is the either the + * number of (two-byte) characters if the character set is Unicode + * or the number of bytes if the character set is not Unicode. + * The length includes terminating 0x00 bytes which we have to strip + * off to create a Java string. */ + long sLength = LittleEndian.getUInt(src, o); + o += LittleEndian.INT_SIZE; + + /* Read the string. */ + final StringBuffer b = new StringBuffer(); + switch (codepage) + { + case -1: + { + /* Without a codepage the length is equal to the number of + * bytes. */ + b.append(new String(src, o, (int) sLength)); + break; + } + case Constants.CP_UNICODE: + { + /* The length is the number of characters, i.e. the number + * of bytes is twice the number of the characters. */ + final int nrBytes = (int) (sLength * 2); + final byte[] h = new byte[nrBytes]; + for (int i2 = 0; i2 < nrBytes; i2 += 2) + { + h[i2] = src[o + i2 + 1]; + h[i2 + 1] = src[o + i2]; + } + b.append(new String(h, 0, nrBytes, + VariantSupport.codepageToEncoding(codepage))); + break; + } + default: + { + /* For encodings other than Unicode the length is the number + * of bytes. */ + b.append(new String(src, o, (int) sLength, + VariantSupport.codepageToEncoding(codepage))); + break; + } + } + + /* Strip 0x00 characters from the end of the string: */ + while (b.length() > 0 && b.charAt(b.length() - 1) == 0x00) + b.setLength(b.length() - 1); + if (codepage == Constants.CP_UNICODE) + { + if (sLength % 2 == 1) + sLength++; + o += (sLength + sLength); + } + else + o += sLength; + m.put(id, b.toString()); + } + } + catch (RuntimeException ex) + { + final POILogger l = POILogFactory.getLogger(getClass()); + l.log(POILogger.WARN, + "The property set's dictionary contains bogus data. " + + "All dictionary entries starting with the one with ID " + + id + " will be ignored.", ex); + } + return m; + } + + /** + *

Compares two properties.

Please beware that a property with + * ID == 0 is a special case: It does not have a type, and its value is the + * section's dictionary. Another special case are strings: Two properties + * may have the different types Variant.VT_LPSTR and Variant.VT_LPWSTR;

+ * + * @see Object#equals(java.lang.Object) + */ + public boolean equals(final Object o) + { + if (!(o instanceof Property)) { + return false; + } + final Property p = (Property) o; + final Object pValue = p.getValue(); + final long pId = p.getID(); + if (id != pId || (id != 0 && !typesAreEqual(type, p.getType()))) + return false; + if (value == null && pValue == null) + return true; + if (value == null || pValue == null) + return false; + + /* It's clear now that both values are non-null. */ + final Class valueClass = value.getClass(); + final Class pValueClass = pValue.getClass(); + if (!(valueClass.isAssignableFrom(pValueClass)) && + !(pValueClass.isAssignableFrom(valueClass))) + return false; + + if (value instanceof byte[]) + return Util.equal((byte[]) value, (byte[]) pValue); + + return value.equals(pValue); + } + + + + private boolean typesAreEqual(final long t1, final long t2) + { + if (t1 == t2 || + (t1 == Variant.VT_LPSTR && t2 == Variant.VT_LPWSTR) || + (t2 == Variant.VT_LPSTR && t1 == Variant.VT_LPWSTR)) { + return true; + } + return false; + } + + + + /** + * @see Object#hashCode() + */ + public int hashCode() + { + long hashCode = 0; + hashCode += id; + hashCode += type; + if (value != null) + hashCode += value.hashCode(); + final int returnHashCode = (int) (hashCode & 0x0ffffffffL ); + return returnHashCode; + + } + + + + /** + * @see Object#toString() + */ + public String toString() + { + final StringBuffer b = new StringBuffer(); + b.append(getClass().getName()); + b.append('['); + b.append("id: "); + b.append(getID()); + b.append(", type: "); + b.append(getType()); + final Object value = getValue(); + b.append(", value: "); + b.append(value.toString()); + if (value instanceof String) + { + final String s = (String) value; + final int l = s.length(); + final byte[] bytes = new byte[l * 2]; + for (int i = 0; i < l; i++) + { + final char c = s.charAt(i); + final byte high = (byte) ((c & 0x00ff00) >> 8); + final byte low = (byte) ((c & 0x0000ff) >> 0); + bytes[i * 2] = high; + bytes[i * 2 + 1] = low; + } + final String hex = HexDump.dump(bytes, 0L, 0); + b.append(" ["); + b.append(hex); + b.append("]"); + } + b.append(']'); + return b.toString(); + } + +} Index: /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/PropertySet.java =================================================================== --- /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/PropertySet.java (revision 28000) +++ /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/PropertySet.java (revision 28000) @@ -0,0 +1,623 @@ +/* ==================================================================== + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +==================================================================== */ + +package org.apache.poi.hpsf; + +import java.io.IOException; +import java.io.InputStream; +import java.io.UnsupportedEncodingException; +import java.util.ArrayList; +import java.util.List; + +import org.apache.poi.hpsf.wellknown.SectionIDMap; +import org.apache.poi.util.LittleEndian; + +/** + *

Represents a property set in the Horrible Property Set Format + * (HPSF). These are usually metadata of a Microsoft Office + * document.

+ * + *

An application that wants to access these metadata should create + * an instance of this class or one of its subclasses by calling the + * factory method {@link PropertySetFactory#create} and then retrieve + * the information its needs by calling appropriate methods.

+ * + *

{@link PropertySetFactory#create} does its work by calling one + * of the constructors {@link PropertySet#PropertySet(InputStream)} or + * {@link PropertySet#PropertySet(byte[])}. If the constructor's + * argument is not in the Horrible Property Set Format, i.e. not a + * property set stream, or if any other error occurs, an appropriate + * exception is thrown.

+ * + *

A {@link PropertySet} has a list of {@link Section}s, and each + * {@link Section} has a {@link Property} array. Use {@link + * #getSections} to retrieve the {@link Section}s, then call {@link + * Section#getProperties} for each {@link Section} to get hold of the + * {@link Property} arrays.

Since the vast majority of {@link + * PropertySet}s contains only a single {@link Section}, the + * convenience method {@link #getProperties} returns the properties of + * a {@link PropertySet}'s {@link Section} (throwing a {@link + * NoSingleSectionException} if the {@link PropertySet} contains more + * (or less) than exactly one {@link Section}).

+ * + * @author Rainer Klute <klute@rainer-klute.de> + * @author Drew Varner (Drew.Varner hanginIn sc.edu) + */ +public class PropertySet +{ + + /** + *

The "byteOrder" field must equal this value.

+ */ + static final byte[] BYTE_ORDER_ASSERTION = + new byte[] {(byte) 0xFE, (byte) 0xFF}; + + /** + *

Specifies this {@link PropertySet}'s byte order. See the + * HPFS documentation for details!

+ */ + protected int byteOrder; + + /** + *

Returns the property set stream's low-level "byte order" + * field. It is always 0xFFFE .

+ * + * @return The property set stream's low-level "byte order" field. + */ + public int getByteOrder() + { + return byteOrder; + } + + + + /** + *

The "format" field must equal this value.

+ */ + static final byte[] FORMAT_ASSERTION = + new byte[]{(byte) 0x00, (byte) 0x00}; + + /** + *

Specifies this {@link PropertySet}'s format. See the HPFS + * documentation for details!

+ */ + protected int format; + + /** + *

Returns the property set stream's low-level "format" + * field. It is always 0x0000 .

+ * + * @return The property set stream's low-level "format" field. + */ + public int getFormat() + { + return format; + } + + + + /** + *

Specifies the version of the operating system that created + * this {@link PropertySet}. See the HPFS documentation for + * details!

+ */ + protected int osVersion; + + /** + *

If the OS version field holds this value the property set stream was + * created on a 32-bit Windows system.

+ */ + public static final int OS_WIN32 = 0x0002; + + /** + *

Returns the property set stream's low-level "OS version" + * field.

+ * + * @return The property set stream's low-level "OS version" field. + */ + public int getOSVersion() + { + return osVersion; + } + + + + /** + *

Specifies this {@link PropertySet}'s "classID" field. See + * the HPFS documentation for details!

+ */ + protected ClassID classID; + + /** + *

Returns the property set stream's low-level "class ID" + * field.

+ * + * @return The property set stream's low-level "class ID" field. + */ + public ClassID getClassID() + { + return classID; + } + + + + /** + *

Returns the number of {@link Section}s in the property + * set.

+ * + * @return The number of {@link Section}s in the property set. + */ + public int getSectionCount() + { + return sections.size(); + } + + + + /** + *

The sections in this {@link PropertySet}.

+ */ + protected List

sections; + + + /** + *

Returns the {@link Section}s in the property set.

+ * + * @return The {@link Section}s in the property set. + */ + public List

getSections() + { + return sections; + } + + + + /** + *

Creates an empty (uninitialized) {@link PropertySet}.

+ * + *

Please note: For the time being this + * constructor is protected since it is used for internal purposes + * only, but expect it to become public once the property set's + * writing functionality is implemented.

+ */ + protected PropertySet() + { } + + + + /** + *

Creates a {@link PropertySet} instance from an {@link + * InputStream} in the Horrible Property Set Format.

+ * + *

The constructor reads the first few bytes from the stream + * and determines whether it is really a property set stream. If + * it is, it parses the rest of the stream. If it is not, it + * resets the stream to its beginning in order to let other + * components mess around with the data and throws an + * exception.

+ * + * @param stream Holds the data making out the property set + * stream. + * @throws MarkUnsupportedException if the stream does not support + * the {@link InputStream#markSupported} method. + * @throws IOException if the {@link InputStream} cannot not be + * accessed as needed. + * @exception NoPropertySetStreamException if the input stream does not + * contain a property set. + * @exception UnsupportedEncodingException if a character encoding is not + * supported. + */ + public PropertySet(final InputStream stream) + throws NoPropertySetStreamException, MarkUnsupportedException, + IOException, UnsupportedEncodingException + { + if (isPropertySetStream(stream)) + { + final int avail = stream.available(); + final byte[] buffer = new byte[avail]; + stream.read(buffer, 0, buffer.length); + init(buffer, 0, buffer.length); + } + else + throw new NoPropertySetStreamException(); + } + + + + + /** + *

Checks whether an {@link InputStream} is in the Horrible + * Property Set Format.

+ * + * @param stream The {@link InputStream} to check. In order to + * perform the check, the method reads the first bytes from the + * stream. After reading, the stream is reset to the position it + * had before reading. The {@link InputStream} must support the + * {@link InputStream#mark} method. + * @return true if the stream is a property set + * stream, else false. + * @throws MarkUnsupportedException if the {@link InputStream} + * does not support the {@link InputStream#mark} method. + * @exception IOException if an I/O error occurs + */ + public static boolean isPropertySetStream(final InputStream stream) + throws MarkUnsupportedException, IOException + { + /* + * Read at most this many bytes. + */ + final int BUFFER_SIZE = 50; + + /* + * Mark the current position in the stream so that we can + * reset to this position if the stream does not contain a + * property set. + */ + if (!stream.markSupported()) + throw new MarkUnsupportedException(stream.getClass().getName()); + stream.mark(BUFFER_SIZE); + + /* + * Read a couple of bytes from the stream. + */ + final byte[] buffer = new byte[BUFFER_SIZE]; + final int bytes = + stream.read(buffer, 0, + Math.min(buffer.length, stream.available())); + final boolean isPropertySetStream = + isPropertySetStream(buffer, 0, bytes); + stream.reset(); + return isPropertySetStream; + } + + + + /** + *

Checks whether a byte array is in the Horrible Property Set + * Format.

+ * + * @param src The byte array to check. + * @param offset The offset in the byte array. + * @param length The significant number of bytes in the byte + * array. Only this number of bytes will be checked. + * @return true if the byte array is a property set + * stream, false if not. + */ + public static boolean isPropertySetStream(final byte[] src, + final int offset, + final int length) + { + /* FIXME (3): Ensure that at most "length" bytes are read. */ + + /* + * Read the header fields of the stream. They must always be + * there. + */ + int o = offset; + final int byteOrder = LittleEndian.getUShort(src, o); + o += LittleEndian.SHORT_SIZE; + byte[] temp = new byte[LittleEndian.SHORT_SIZE]; + LittleEndian.putShort(temp, (short) byteOrder); + if (!Util.equal(temp, BYTE_ORDER_ASSERTION)) + return false; + final int format = LittleEndian.getUShort(src, o); + o += LittleEndian.SHORT_SIZE; + temp = new byte[LittleEndian.SHORT_SIZE]; + LittleEndian.putShort(temp, (short) format); + if (!Util.equal(temp, FORMAT_ASSERTION)) + return false; + // final long osVersion = LittleEndian.getUInt(src, offset); + o += LittleEndian.INT_SIZE; + // final ClassID classID = new ClassID(src, offset); + o += ClassID.LENGTH; + final long sectionCount = LittleEndian.getUInt(src, o); + o += LittleEndian.INT_SIZE; + if (sectionCount < 0) + return false; + return true; + } + + + + /** + *

Initializes this {@link PropertySet} instance from a byte + * array. The method assumes that it has been checked already that + * the byte array indeed represents a property set stream. It does + * no more checks on its own.

+ * + * @param src Byte array containing the property set stream + * @param offset The property set stream starts at this offset + * from the beginning of src + * @param length Length of the property set stream. + * @throws UnsupportedEncodingException if HPSF does not (yet) support the + * property set's character encoding. + */ + private void init(final byte[] src, final int offset, final int length) + throws UnsupportedEncodingException + { + /* FIXME (3): Ensure that at most "length" bytes are read. */ + + /* + * Read the stream's header fields. + */ + int o = offset; + byteOrder = LittleEndian.getUShort(src, o); + o += LittleEndian.SHORT_SIZE; + format = LittleEndian.getUShort(src, o); + o += LittleEndian.SHORT_SIZE; + osVersion = (int) LittleEndian.getUInt(src, o); + o += LittleEndian.INT_SIZE; + classID = new ClassID(src, o); + o += ClassID.LENGTH; + final int sectionCount = LittleEndian.getInt(src, o); + o += LittleEndian.INT_SIZE; + if (sectionCount < 0) + throw new HPSFRuntimeException("Section count " + sectionCount + + " is negative."); + + /* + * Read the sections, which are following the header. They + * start with an array of section descriptions. Each one + * consists of a format ID telling what the section contains + * and an offset telling how many bytes from the start of the + * stream the section begins. + */ + /* + * Most property sets have only one section. The Document + * Summary Information stream has 2. Everything else is a rare + * exception and is no longer fostered by Microsoft. + */ + sections = new ArrayList

(sectionCount); + + /* + * Loop over the section descriptor array. Each descriptor + * consists of a ClassID and a DWord, and we have to increment + * "offset" accordingly. + */ + for (int i = 0; i < sectionCount; i++) + { + final Section s = new Section(src, o); + o += ClassID.LENGTH + LittleEndian.INT_SIZE; + sections.add(s); + } + } + + + + /** + *

Checks whether this {@link PropertySet} represents a Summary + * Information.

+ * + * @return true if this {@link PropertySet} + * represents a Summary Information, else false. + */ + public boolean isSummaryInformation() + { + if (sections.size() <= 0) + return false; + return Util.equal(sections.get(0).getFormatID().getBytes(), + SectionIDMap.SUMMARY_INFORMATION_ID); + } + + + + /** + *

Checks whether this {@link PropertySet} is a Document + * Summary Information.

+ * + * @return true if this {@link PropertySet} + * represents a Document Summary Information, else false. + */ + public boolean isDocumentSummaryInformation() + { + if (sections.size() <= 0) + return false; + return Util.equal(sections.get(0).getFormatID().getBytes(), + SectionIDMap.DOCUMENT_SUMMARY_INFORMATION_ID[0]); + } + + + + /** + *

Convenience method returning the {@link Property} array + * contained in this property set. It is a shortcut for getting + * the {@link PropertySet}'s {@link Section}s list and then + * getting the {@link Property} array from the first {@link + * Section}.

+ * + * @return The properties of the only {@link Section} of this + * {@link PropertySet}. + * @throws NoSingleSectionException if the {@link PropertySet} has + * more or less than one {@link Section}. + */ + public Property[] getProperties() + throws NoSingleSectionException + { + return getFirstSection().getProperties(); + } + + + + /** + *

Convenience method returning the value of the property with + * the specified ID. If the property is not available, + * null is returned and a subsequent call to {@link + * #wasNull} will return true .

+ * + * @param id The property ID + * @return The property value + * @throws NoSingleSectionException if the {@link PropertySet} has + * more or less than one {@link Section}. + */ + protected Object getProperty(final int id) throws NoSingleSectionException + { + return getFirstSection().getProperty(id); + } + + + + /** + *

Convenience method returning the value of a boolean property + * with the specified ID. If the property is not available, + * false is returned. A subsequent call to {@link + * #wasNull} will return true to let the caller + * distinguish that case from a real property value of + * false.

+ * + * @param id The property ID + * @return The property value + * @throws NoSingleSectionException if the {@link PropertySet} has + * more or less than one {@link Section}. + */ + protected boolean getPropertyBooleanValue(final int id) + throws NoSingleSectionException + { + return getFirstSection().getPropertyBooleanValue(id); + } + + + + /** + *

Convenience method returning the value of the numeric + * property with the specified ID. If the property is not + * available, 0 is returned. A subsequent call to {@link #wasNull} + * will return true to let the caller distinguish + * that case from a real property value of 0.

+ * + * @param id The property ID + * @return The propertyIntValue value + * @throws NoSingleSectionException if the {@link PropertySet} has + * more or less than one {@link Section}. + */ + protected int getPropertyIntValue(final int id) + throws NoSingleSectionException + { + return getFirstSection().getPropertyIntValue(id); + } + + + + /** + *

Checks whether the property which the last call to {@link + * #getPropertyIntValue} or {@link #getProperty} tried to access + * was available or not. This information might be important for + * callers of {@link #getPropertyIntValue} since the latter + * returns 0 if the property does not exist. Using {@link + * #wasNull}, the caller can distiguish this case from a + * property's real value of 0.

+ * + * @return true if the last call to {@link + * #getPropertyIntValue} or {@link #getProperty} tried to access a + * property that was not available, else false. + * @throws NoSingleSectionException if the {@link PropertySet} has + * more than one {@link Section}. + */ + public boolean wasNull() throws NoSingleSectionException + { + return getFirstSection().wasNull(); + } + + + + /** + *

Gets the {@link PropertySet}'s first section.

+ * + * @return The {@link PropertySet}'s first section. + */ + public Section getFirstSection() + { + if (getSectionCount() < 1) + throw new MissingSectionException("Property set does not contain any sections."); + return sections.get(0); + } + + /** + *

Returns true if the PropertySet is equal + * to the specified parameter, else false.

+ * + * @param o the object to compare this PropertySet with + * + * @return true if the objects are equal, false + * if not + */ + public boolean equals(final Object o) + { + if (o == null || !(o instanceof PropertySet)) + return false; + final PropertySet ps = (PropertySet) o; + int byteOrder1 = ps.getByteOrder(); + int byteOrder2 = getByteOrder(); + ClassID classID1 = ps.getClassID(); + ClassID classID2 = getClassID(); + int format1 = ps.getFormat(); + int format2 = getFormat(); + int osVersion1 = ps.getOSVersion(); + int osVersion2 = getOSVersion(); + int sectionCount1 = ps.getSectionCount(); + int sectionCount2 = getSectionCount(); + if (byteOrder1 != byteOrder2 || + !classID1.equals(classID2) || + format1 != format2 || + osVersion1 != osVersion2 || + sectionCount1 != sectionCount2) + return false; + + /* Compare the sections: */ + return Util.equals(getSections(), ps.getSections()); + } + + + + /** + * @see Object#hashCode() + */ + public int hashCode() + { + throw new UnsupportedOperationException("FIXME: Not yet implemented."); + } + + + + /** + * @see Object#toString() + */ + public String toString() + { + final StringBuffer b = new StringBuffer(); + final int sectionCount = getSectionCount(); + b.append(getClass().getName()); + b.append('['); + b.append("byteOrder: "); + b.append(getByteOrder()); + b.append(", classID: "); + b.append(getClassID()); + b.append(", format: "); + b.append(getFormat()); + b.append(", OSVersion: "); + b.append(getOSVersion()); + b.append(", sectionCount: "); + b.append(sectionCount); + b.append(", sections: [\n"); + final List

sections = getSections(); + for (int i = 0; i < sectionCount; i++) + b.append(sections.get(i).toString()); + b.append(']'); + b.append(']'); + return b.toString(); + } +} Index: /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/PropertySetFactory.java =================================================================== --- /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/PropertySetFactory.java (revision 28000) +++ /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/PropertySetFactory.java (revision 28000) @@ -0,0 +1,77 @@ +/* ==================================================================== + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +==================================================================== */ + +package org.apache.poi.hpsf; + +import java.io.IOException; +import java.io.InputStream; +import java.io.UnsupportedEncodingException; +import java.rmi.UnexpectedException; + +/** + *

Factory class to create instances of {@link SummaryInformation}, + * {@link DocumentSummaryInformation} and {@link PropertySet}.

+ * + * @author Rainer Klute <klute@rainer-klute.de> + */ +public class PropertySetFactory +{ + + /** + *

Creates the most specific {@link PropertySet} from an {@link + * InputStream}. This is preferrably a {@link + * DocumentSummaryInformation} or a {@link SummaryInformation}. If + * the specified {@link InputStream} does not contain a property + * set stream, an exception is thrown and the {@link InputStream} + * is repositioned at its beginning.

+ * + * @param stream Contains the property set stream's data. + * @return The created {@link PropertySet}. + * @throws NoPropertySetStreamException if the stream does not + * contain a property set. + * @throws MarkUnsupportedException if the stream does not support + * the mark operation. + * @throws IOException if some I/O problem occurs. + * @exception UnsupportedEncodingException if the specified codepage is not + * supported. + */ + public static PropertySet create(final InputStream stream) + throws NoPropertySetStreamException, MarkUnsupportedException, + UnsupportedEncodingException, IOException + { + final PropertySet ps = new PropertySet(stream); + try + { + if (ps.isSummaryInformation()) + return new SummaryInformation(ps); + else if (ps.isDocumentSummaryInformation()) + return new DocumentSummaryInformation(ps); + else + return ps; + } + catch (UnexpectedPropertySetTypeException ex) + { + /* This exception will never be throws because we already checked + * explicitly for this case above. */ + throw new UnexpectedException(ex.toString()); + } + } + + + +} Index: /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/ReadingNotSupportedException.java =================================================================== --- /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/ReadingNotSupportedException.java (revision 28000) +++ /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/ReadingNotSupportedException.java (revision 28000) @@ -0,0 +1,47 @@ +/* ==================================================================== + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +==================================================================== */ + +package org.apache.poi.hpsf; + +/** + *

This exception is thrown when HPSF tries to read a (yet) unsupported + * variant type.

+ * + * @see WritingNotSupportedException + * @see UnsupportedVariantTypeException + * + * @author Rainer Klute <klute@rainer-klute.de> + */ +@SuppressWarnings("serial") +public class ReadingNotSupportedException + extends UnsupportedVariantTypeException +{ + + /** + *

Constructor

+ * + * @param variantType The unsupported variant type. + * @param value The value. + */ + public ReadingNotSupportedException(final long variantType, + final Object value) + { + super(variantType, value); + } + +} Index: /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/Section.java =================================================================== --- /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/Section.java (revision 28000) +++ /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/Section.java (revision 28000) @@ -0,0 +1,627 @@ +/* ==================================================================== + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +==================================================================== */ + +package org.apache.poi.hpsf; + +import java.io.UnsupportedEncodingException; +import java.util.ArrayList; +import java.util.Collections; +import java.util.Iterator; +import java.util.List; +import java.util.Map; + +import org.apache.poi.hpsf.wellknown.PropertyIDMap; +import org.apache.poi.util.LittleEndian; + +/** + *

Represents a section in a {@link PropertySet}.

+ * + * @author Rainer Klute <klute@rainer-klute.de> + * @author Drew Varner (Drew.Varner allUpIn sc.edu) + */ +public class Section +{ + + /** + *

Maps property IDs to section-private PID strings. These + * strings can be found in the property with ID 0.

+ */ + protected Map dictionary; + + /** + *

The section's format ID, {@link #getFormatID}.

+ */ + protected ClassID formatID; + + + /** + *

Returns the format ID. The format ID is the "type" of the + * section. For example, if the format ID of the first {@link + * Section} contains the bytes specified by + * org.apache.poi.hpsf.wellknown.SectionIDMap.SUMMARY_INFORMATION_ID + * the section (and thus the property set) is a SummaryInformation.

+ * + * @return The format ID + */ + public ClassID getFormatID() + { + return formatID; + } + + + + /** + * @see #getOffset + */ + protected long offset; + + + /** + *

Returns the offset of the section in the stream.

+ * + * @return The offset of the section in the stream. + */ + public long getOffset() + { + return offset; + } + + + + /** + * @see #getSize + */ + protected int size; + + + /** + *

Returns the section's size in bytes.

+ * + * @return The section's size in bytes. + */ + public int getSize() + { + return size; + } + + + + /** + *

Returns the number of properties in this section.

+ * + * @return The number of properties in this section. + */ + public int getPropertyCount() + { + return properties.length; + } + + + + /** + * @see #getProperties + */ + protected Property[] properties; + + + /** + *

Returns this section's properties.

+ * + * @return This section's properties. + */ + public Property[] getProperties() + { + return properties; + } + + + + /** + *

Creates an empty and uninitialized {@link Section}. + */ + protected Section() + { } + + + + /** + *

Creates a {@link Section} instance from a byte array.

+ * + * @param src Contains the complete property set stream. + * @param offset The position in the stream that points to the + * section's format ID. + * + * @exception UnsupportedEncodingException if the section's codepage is not + * supported. + */ + @SuppressWarnings("unchecked") + public Section(final byte[] src, final int offset) + throws UnsupportedEncodingException + { + int o1 = offset; + + /* + * Read the format ID. + */ + formatID = new ClassID(src, o1); + o1 += ClassID.LENGTH; + + /* + * Read the offset from the stream's start and positions to + * the section header. + */ + this.offset = LittleEndian.getUInt(src, o1); + o1 = (int) this.offset; + + /* + * Read the section length. + */ + size = (int) LittleEndian.getUInt(src, o1); + o1 += LittleEndian.INT_SIZE; + + /* + * Read the number of properties. + */ + final int propertyCount = (int) LittleEndian.getUInt(src, o1); + o1 += LittleEndian.INT_SIZE; + + /* + * Read the properties. The offset is positioned at the first + * entry of the property list. There are two problems: + * + * 1. For each property we have to find out its length. In the + * property list we find each property's ID and its offset relative + * to the section's beginning. Unfortunately the properties in the + * property list need not to be in ascending order, so it is not + * possible to calculate the length as + * (offset of property(i+1) - offset of property(i)). Before we can + * that we first have to sort the property list by ascending offsets. + * + * 2. We have to read the property with ID 1 before we read other + * properties, at least before other properties containing strings. + * The reason is that property 1 specifies the codepage. If it is + * 1200, all strings are in Unicode. In other words: Before we can + * read any strings we have to know whether they are in Unicode or + * not. Unfortunately property 1 is not guaranteed to be the first in + * a section. + * + * The algorithm below reads the properties in two passes: The first + * one looks for property ID 1 and extracts the codepage number. The + * seconds pass reads the other properties. + */ + properties = new Property[propertyCount]; + + /* Pass 1: Read the property list. */ + int pass1Offset = o1; + final List propertyList = new ArrayList(propertyCount); + PropertyListEntry ple; + for (int i = 0; i < properties.length; i++) + { + ple = new PropertyListEntry(); + + /* Read the property ID. */ + ple.id = (int) LittleEndian.getUInt(src, pass1Offset); + pass1Offset += LittleEndian.INT_SIZE; + + /* Offset from the section's start. */ + ple.offset = (int) LittleEndian.getUInt(src, pass1Offset); + pass1Offset += LittleEndian.INT_SIZE; + + /* Add the entry to the property list. */ + propertyList.add(ple); + } + + /* Sort the property list by ascending offsets: */ + Collections.sort(propertyList); + + /* Calculate the properties' lengths. */ + for (int i = 0; i < propertyCount - 1; i++) + { + PropertyListEntry ple1 = propertyList.get(i); + PropertyListEntry ple2 = propertyList.get(i + 1); + ple1.length = ple2.offset - ple1.offset; + } + if (propertyCount > 0) + { + ple = propertyList.get(propertyCount - 1); + ple.length = size - ple.offset; + } + + /* Look for the codepage. */ + int codepage = -1; + for (final Iterator i = propertyList.iterator(); + codepage == -1 && i.hasNext();) + { + ple = i.next(); + + /* Read the codepage if the property ID is 1. */ + if (ple.id == PropertyIDMap.PID_CODEPAGE) + { + /* Read the property's value type. It must be + * VT_I2. */ + int o = (int) (this.offset + ple.offset); + final long type = LittleEndian.getUInt(src, o); + o += LittleEndian.INT_SIZE; + + if (type != Variant.VT_I2) + throw new HPSFRuntimeException + ("Value type of property ID 1 is not VT_I2 but " + + type + "."); + + /* Read the codepage number. */ + codepage = LittleEndian.getUShort(src, o); + } + } + + /* Pass 2: Read all properties - including the codepage property, + * if available. */ + int i1 = 0; + for (final Iterator i = propertyList.iterator(); i.hasNext();) + { + ple = i.next(); + Property p = new Property(ple.id, src, + this.offset + ple.offset, + ple.length, codepage); + if (p.getID() == PropertyIDMap.PID_CODEPAGE) + p = new Property(p.getID(), p.getType(), Integer.valueOf(codepage)); + properties[i1++] = p; + } + + /* + * Extract the dictionary (if available). + */ + dictionary = (Map) getProperty(0); + } + + + + /** + *

Represents an entry in the property list and holds a property's ID and + * its offset from the section's beginning.

+ */ + class PropertyListEntry implements Comparable + { + int id; + int offset; + int length; + + /** + *

Compares this {@link PropertyListEntry} with another one by their + * offsets. A {@link PropertyListEntry} is "smaller" than another one if + * its offset from the section's begin is smaller.

+ * + * @see Comparable#compareTo(java.lang.Object) + */ + public int compareTo(final PropertyListEntry o) + { + final int otherOffset = o.offset; + if (offset < otherOffset) + return -1; + else if (offset == otherOffset) + return 0; + else + return 1; + } + + public String toString() + { + final StringBuffer b = new StringBuffer(); + b.append(getClass().getName()); + b.append("[id="); + b.append(id); + b.append(", offset="); + b.append(offset); + b.append(", length="); + b.append(length); + b.append(']'); + return b.toString(); + } + } + + + + /** + *

Returns the value of the property with the specified ID. If + * the property is not available, null is returned + * and a subsequent call to {@link #wasNull} will return + * true.

+ * + * @param id The property's ID + * + * @return The property's value + */ + public Object getProperty(final long id) + { + wasNull = false; + for (int i = 0; i < properties.length; i++) + if (id == properties[i].getID()) + return properties[i].getValue(); + wasNull = true; + return null; + } + + + + /** + *

Returns the value of the numeric property with the specified + * ID. If the property is not available, 0 is returned. A + * subsequent call to {@link #wasNull} will return + * true to let the caller distinguish that case from + * a real property value of 0.

+ * + * @param id The property's ID + * + * @return The property's value + */ + protected int getPropertyIntValue(final long id) + { + final Number i; + final Object o = getProperty(id); + if (o == null) + return 0; + if (!(o instanceof Long || o instanceof Integer)) + throw new HPSFRuntimeException + ("This property is not an integer type, but " + + o.getClass().getName() + "."); + i = (Number) o; + return i.intValue(); + } + + + + /** + *

Returns the value of the boolean property with the specified + * ID. If the property is not available, false is + * returned. A subsequent call to {@link #wasNull} will return + * true to let the caller distinguish that case from + * a real property value of false.

+ * + * @param id The property's ID + * + * @return The property's value + */ + protected boolean getPropertyBooleanValue(final int id) + { + final Boolean b = (Boolean) getProperty(id); + if (b == null) { + return false; + } + return b.booleanValue(); + } + + + + /** + *

This member is true if the last call to {@link + * #getPropertyIntValue} or {@link #getProperty} tried to access a + * property that was not available, else false.

+ */ + private boolean wasNull; + + + /** + *

Checks whether the property which the last call to {@link + * #getPropertyIntValue} or {@link #getProperty} tried to access + * was available or not. This information might be important for + * callers of {@link #getPropertyIntValue} since the latter + * returns 0 if the property does not exist. Using {@link + * #wasNull} the caller can distiguish this case from a property's + * real value of 0.

+ * + * @return true if the last call to {@link + * #getPropertyIntValue} or {@link #getProperty} tried to access a + * property that was not available, else false. + */ + public boolean wasNull() + { + return wasNull; + } + + /** + *

Checks whether this section is equal to another object. The result is + * false if one of the the following conditions holds:

+ * + *

The other object is not a {@link Section}.
The format IDs of the two sections are not equal.
The sections have a different number of properties. However, + * properties with ID 1 (codepage) are not counted.
The other object is not a {@link Section}.
The properties have different values. The order of the properties + * is irrelevant.

+ * + * @param o The object to compare this section with + * @return true if the objects are equal, false if + * not + */ + public boolean equals(final Object o) + { + if (o == null || !(o instanceof Section)) + return false; + final Section s = (Section) o; + if (!s.getFormatID().equals(getFormatID())) + return false; + + /* Compare all properties except 0 and 1 as they must be handled + * specially. */ + Property[] pa1 = new Property[getProperties().length]; + Property[] pa2 = new Property[s.getProperties().length]; + System.arraycopy(getProperties(), 0, pa1, 0, pa1.length); + System.arraycopy(s.getProperties(), 0, pa2, 0, pa2.length); + + /* Extract properties 0 and 1 and remove them from the copy of the + * arrays. */ + Property p10 = null; + Property p20 = null; + for (int i = 0; i < pa1.length; i++) + { + final long id = pa1[i].getID(); + if (id == 0) + { + p10 = pa1[i]; + pa1 = remove(pa1, i); + i--; + } + if (id == 1) + { + // p11 = pa1[i]; + pa1 = remove(pa1, i); + i--; + } + } + for (int i = 0; i < pa2.length; i++) + { + final long id = pa2[i].getID(); + if (id == 0) + { + p20 = pa2[i]; + pa2 = remove(pa2, i); + i--; + } + if (id == 1) + { + // p21 = pa2[i]; + pa2 = remove(pa2, i); + i--; + } + } + + /* If the number of properties (not counting property 1) is unequal the + * sections are unequal. */ + if (pa1.length != pa2.length) + return false; + + /* If the dictionaries are unequal the sections are unequal. */ + boolean dictionaryEqual = true; + if (p10 != null && p20 != null) + dictionaryEqual = p10.getValue().equals(p20.getValue()); + else if (p10 != null || p20 != null) + dictionaryEqual = false; + if (dictionaryEqual) { + return Util.equals(pa1, pa2); + } + return false; + } + + + + /** + *

Removes a field from a property array. The resulting array is + * compactified and returned.

+ * + * @param pa The property array. + * @param i The index of the field to be removed. + * @return the compactified array. + */ + private Property[] remove(final Property[] pa, final int i) + { + final Property[] h = new Property[pa.length - 1]; + if (i > 0) + System.arraycopy(pa, 0, h, 0, i); + System.arraycopy(pa, i + 1, h, i, h.length - i); + return h; + } + + + + /** + * @see Object#hashCode() + */ + public int hashCode() + { + long hashCode = 0; + hashCode += getFormatID().hashCode(); + final Property[] pa = getProperties(); + for (int i = 0; i < pa.length; i++) + hashCode += pa[i].hashCode(); + final int returnHashCode = (int) (hashCode & 0x0ffffffffL); + return returnHashCode; + } + + + + /** + * @see Object#toString() + */ + public String toString() + { + final StringBuffer b = new StringBuffer(); + final Property[] pa = getProperties(); + b.append(getClass().getName()); + b.append('['); + b.append("formatID: "); + b.append(getFormatID()); + b.append(", offset: "); + b.append(getOffset()); + b.append(", propertyCount: "); + b.append(getPropertyCount()); + b.append(", size: "); + b.append(getSize()); + b.append(", properties: [\n"); + for (int i = 0; i < pa.length; i++) + { + b.append(pa[i].toString()); + b.append(",\n"); + } + b.append(']'); + b.append(']'); + return b.toString(); + } + + + + /** + *

Gets the section's dictionary. A dictionary allows an application to + * use human-readable property names instead of numeric property IDs. It + * contains mappings from property IDs to their associated string + * values. The dictionary is stored as the property with ID 0. The codepage + * for the strings in the dictionary is defined by property with ID 1.

+ * + * @return the dictionary or null if the section does not have + * a dictionary. + */ + public Map getDictionary() + { + return dictionary; + } + + + + /** + *

Gets the section's codepage, if any.

+ * + * @return The section's codepage if one is defined, else -1. + */ + public int getCodepage() + { + final Integer codepage = + (Integer) getProperty(PropertyIDMap.PID_CODEPAGE); + if (codepage == null) + return -1; + int cp = codepage.intValue(); + return cp; + } + +} Index: /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/SpecialPropertySet.java =================================================================== --- /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/SpecialPropertySet.java (revision 28000) +++ /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/SpecialPropertySet.java (revision 28000) @@ -0,0 +1,341 @@ +/* ==================================================================== + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +==================================================================== */ + +package org.apache.poi.hpsf; + +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.util.List; + +import org.apache.poi.hpsf.wellknown.PropertyIDMap; +import org.apache.poi.poifs.filesystem.DirectoryEntry; + +/** + *

Abstract superclass for the convenience classes {@link + * SummaryInformation} and {@link DocumentSummaryInformation}.

+ * + *

The motivation behind this class is quite nasty if you look + * behind the scenes, but it serves the application programmer well by + * providing him with the easy-to-use {@link SummaryInformation} and + * {@link DocumentSummaryInformation} classes. When parsing the data a + * property set stream consists of (possibly coming from an {@link + * java.io.InputStream}) we want to read and process each byte only + * once. Since we don't know in advance which kind of property set we + * have, we can expect only the most general {@link + * PropertySet}. Creating a special subclass should be as easy as + * calling the special subclass' constructor and pass the general + * {@link PropertySet} in. To make things easy internally, the special + * class just holds a reference to the general {@link PropertySet} and + * delegates all method calls to it.

+ * + *

A cleaner implementation would have been like this: The {@link + * PropertySetFactory} parses the stream data into some internal + * object first. Then it finds out whether the stream is a {@link + * SummaryInformation}, a {@link DocumentSummaryInformation} or a + * general {@link PropertySet}. However, the current implementation + * went the other way round historically: the convenience classes came + * only late to my mind.

+ * + * @author Rainer Klute <klute@rainer-klute.de> + */ +public abstract class SpecialPropertySet extends MutablePropertySet +{ + /** + * The id to name mapping of the properties + * in this set. + */ + public abstract PropertyIDMap getPropertySetIDMap(); + + /** + *

The "real" property set SpecialPropertySet + * delegates to.

+ */ + private MutablePropertySet delegate; + + + + /** + *

Creates a SpecialPropertySet. + * + * @param ps The property set to be encapsulated by the + * SpecialPropertySet + */ + public SpecialPropertySet(final PropertySet ps) + { + delegate = new MutablePropertySet(ps); + } + + /** + * @see PropertySet#getByteOrder + */ + public int getByteOrder() + { + return delegate.getByteOrder(); + } + + + + /** + * @see PropertySet#getFormat + */ + public int getFormat() + { + return delegate.getFormat(); + } + + + + /** + * @see PropertySet#getOSVersion + */ + public int getOSVersion() + { + return delegate.getOSVersion(); + } + + + + /** + * @see PropertySet#getClassID + */ + public ClassID getClassID() + { + return delegate.getClassID(); + } + + + + /** + * @see PropertySet#getSectionCount + */ + public int getSectionCount() + { + return delegate.getSectionCount(); + } + + + + /** + * @see PropertySet#getSections + */ + public List

getSections() + { + return delegate.getSections(); + } + + + + /** + * @see PropertySet#isSummaryInformation + */ + public boolean isSummaryInformation() + { + return delegate.isSummaryInformation(); + } + + + + /** + * @see PropertySet#isDocumentSummaryInformation + */ + public boolean isDocumentSummaryInformation() + { + return delegate.isDocumentSummaryInformation(); + } + + + + /** + * @see PropertySet#getSingleSection + */ + public Section getFirstSection() + { + return delegate.getFirstSection(); + } + + + /** + * @see org.apache.poi.hpsf.MutablePropertySet#addSection(org.apache.poi.hpsf.Section) + */ + public void addSection(final Section section) + { + delegate.addSection(section); + } + + + + /** + * @see org.apache.poi.hpsf.MutablePropertySet#clearSections() + */ + public void clearSections() + { + delegate.clearSections(); + } + + + + /** + * @see org.apache.poi.hpsf.MutablePropertySet#setByteOrder(int) + */ + public void setByteOrder(final int byteOrder) + { + delegate.setByteOrder(byteOrder); + } + + + + /** + * @see org.apache.poi.hpsf.MutablePropertySet#setClassID(org.apache.poi.hpsf.ClassID) + */ + public void setClassID(final ClassID classID) + { + delegate.setClassID(classID); + } + + + + /** + * @see org.apache.poi.hpsf.MutablePropertySet#setFormat(int) + */ + public void setFormat(final int format) + { + delegate.setFormat(format); + } + + + + /** + * @see org.apache.poi.hpsf.MutablePropertySet#setOSVersion(int) + */ + public void setOSVersion(final int osVersion) + { + delegate.setOSVersion(osVersion); + } + + + + /** + * @see org.apache.poi.hpsf.MutablePropertySet#toInputStream() + */ + public InputStream toInputStream() throws IOException, WritingNotSupportedException + { + return delegate.toInputStream(); + } + + + + /** + * @see org.apache.poi.hpsf.MutablePropertySet#write(org.apache.poi.poifs.filesystem.DirectoryEntry, java.lang.String) + */ + public void write(final DirectoryEntry dir, final String name) throws WritingNotSupportedException, IOException + { + delegate.write(dir, name); + } + + + + /** + * @see org.apache.poi.hpsf.MutablePropertySet#write(java.io.OutputStream) + */ + public void write(final OutputStream out) throws WritingNotSupportedException, IOException + { + delegate.write(out); + } + + + + /** + * @see org.apache.poi.hpsf.PropertySet#equals(java.lang.Object) + */ + public boolean equals(final Object o) + { + return delegate.equals(o); + } + + + + /** + * @see org.apache.poi.hpsf.PropertySet#getProperties() + */ + public Property[] getProperties() throws NoSingleSectionException + { + return delegate.getProperties(); + } + + + + /** + * @see org.apache.poi.hpsf.PropertySet#getProperty(int) + */ + protected Object getProperty(final int id) throws NoSingleSectionException + { + return delegate.getProperty(id); + } + + + + /** + * @see org.apache.poi.hpsf.PropertySet#getPropertyBooleanValue(int) + */ + protected boolean getPropertyBooleanValue(final int id) throws NoSingleSectionException + { + return delegate.getPropertyBooleanValue(id); + } + + + + /** + * @see org.apache.poi.hpsf.PropertySet#getPropertyIntValue(int) + */ + protected int getPropertyIntValue(final int id) throws NoSingleSectionException + { + return delegate.getPropertyIntValue(id); + } + + + + /** + * @see org.apache.poi.hpsf.PropertySet#hashCode() + */ + public int hashCode() + { + return delegate.hashCode(); + } + + + + /** + * @see org.apache.poi.hpsf.PropertySet#toString() + */ + public String toString() + { + return delegate.toString(); + } + + + + /** + * @see org.apache.poi.hpsf.PropertySet#wasNull() + */ + public boolean wasNull() throws NoSingleSectionException + { + return delegate.wasNull(); + } + +} Index: /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/SummaryInformation.java =================================================================== --- /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/SummaryInformation.java (revision 28000) +++ /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/SummaryInformation.java (revision 28000) @@ -0,0 +1,122 @@ +/* ==================================================================== + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +==================================================================== */ + +package org.apache.poi.hpsf; + +import java.util.Date; + +import org.apache.poi.hpsf.wellknown.PropertyIDMap; + +/** + *

Convenience class representing a Summary Information stream in a + * Microsoft Office document.

+ * + * @author Rainer Klute <klute@rainer-klute.de> + * @see DocumentSummaryInformation + */ +public final class SummaryInformation extends SpecialPropertySet { + + /** + *

The document name a summary information stream usually has in a POIFS + * filesystem.

+ */ + public static final String DEFAULT_STREAM_NAME = "\005SummaryInformation"; + + public PropertyIDMap getPropertySetIDMap() { + return PropertyIDMap.getSummaryInformationProperties(); + } + + + /** + *

Creates a {@link SummaryInformation} from a given {@link + * PropertySet}.

+ * + * @param ps A property set which should be created from a summary + * information stream. + * @throws UnexpectedPropertySetTypeException if ps does not + * contain a summary information stream. + */ + public SummaryInformation(final PropertySet ps) + throws UnexpectedPropertySetTypeException + { + super(ps); + if (!isSummaryInformation()) + throw new UnexpectedPropertySetTypeException("Not a " + + getClass().getName()); + } + + /** + *

Returns the title (or null).

+ * + * @return The title or null + */ + public String getTitle() // NO_UCD + { + return (String) getProperty(PropertyIDMap.PID_TITLE); + } + + /** + *

Returns the author (or null).

+ * + * @return The author or null + */ + public String getAuthor() // NO_UCD + { + return (String) getProperty(PropertyIDMap.PID_AUTHOR); + } + + /** + *

Returns the last author (or null).

+ * + * @return The last author or null + */ + public String getLastAuthor() // NO_UCD + { + return (String) getProperty(PropertyIDMap.PID_LASTAUTHOR); + } + + /** + *

Returns the revision number (or null).

+ * + * @return The revision number or null + */ + public String getRevNumber() // NO_UCD + { + return (String) getProperty(PropertyIDMap.PID_REVNUMBER); + } + + /** + *

Returns the creation time (or null).

+ * + * @return The creation time or null + */ + public Date getCreateDateTime() // NO_UCD + { + return (Date) getProperty(PropertyIDMap.PID_CREATE_DTM); + } + + /** + *

Returns the last save time (or null).

+ * + * @return The last save time or null + */ + public Date getLastSaveDateTime() // NO_UCD + { + return (Date) getProperty(PropertyIDMap.PID_LASTSAVE_DTM); + } +} Index: /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/TypeWriter.java =================================================================== --- /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/TypeWriter.java (revision 28000) +++ /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/TypeWriter.java (revision 28000) @@ -0,0 +1,153 @@ +/* ==================================================================== + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +==================================================================== */ + +package org.apache.poi.hpsf; + +import java.io.IOException; +import java.io.OutputStream; + +import org.apache.poi.util.LittleEndian; + +/** + *

Class for writing little-endian data and more.

+ * + * @author Rainer Klute <klute@rainer-klute.de> + */ +public class TypeWriter +{ + + /** + *

Writes a two-byte value (short) to an output stream.

+ * + * @param out The stream to write to. + * @param n The value to write. + * @return The number of bytes that have been written. + * @exception IOException if an I/O error occurs + */ + public static int writeToStream(final OutputStream out, final short n) + throws IOException + { + final int length = LittleEndian.SHORT_SIZE; + byte[] buffer = new byte[length]; + LittleEndian.putShort(buffer, 0, n); // FIXME: unsigned + out.write(buffer, 0, length); + return length; + } + + + + /** + *

Writes a four-byte value to an output stream.

Writes a eight-byte value to an output stream.

Writes an unsigned four-byte value to an output stream.

+ * + * @param out The stream to write to. + * @param n The value to write. + * @return The number of bytes that have been written to the output stream. + * @exception IOException if an I/O error occurs + */ + public static int writeUIntToStream(final OutputStream out, final long n) + throws IOException + { + long high = n & 0xFFFFFFFF00000000L; + if (high != 0 && high != 0xFFFFFFFF00000000L) + throw new IllegalPropertySetDataException + ("Value " + n + " cannot be represented by 4 bytes."); + return writeToStream(out, (int) n); + } + + + + /** + *

Writes a 16-byte {@link ClassID} to an output stream.

+ * + * @param out The stream to write to + * @param n The value to write + * @return The number of bytes written + * @exception IOException if an I/O error occurs + */ + public static int writeToStream(final OutputStream out, final ClassID n) + throws IOException + { + byte[] b = new byte[16]; + n.write(b, 0); + out.write(b, 0, b.length); + return b.length; + } + + + + + /** + *

Writes a double value value to an output stream.

+ * + * @param out The stream to write to. + * @param n The value to write. + * @exception IOException if an I/O error occurs + * @return The number of bytes written to the output stream. + */ + public static int writeToStream(final OutputStream out, final double n) + throws IOException + { + final int l = LittleEndian.DOUBLE_SIZE; + final byte[] buffer = new byte[l]; + LittleEndian.putDouble(buffer, 0, n); + out.write(buffer, 0, l); + return l; + } + +} Index: /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/UnexpectedPropertySetTypeException.java =================================================================== --- /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/UnexpectedPropertySetTypeException.java (revision 28000) +++ /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/UnexpectedPropertySetTypeException.java (revision 28000) @@ -0,0 +1,56 @@ +/* ==================================================================== + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +==================================================================== */ + +package org.apache.poi.hpsf; + +/** + *

This exception is thrown if a certain type of property set is + * expected (e.g. a Document Summary Information) but the provided + * property set is not of that type.

+ * + *

The constructors of this class are analogous to those of its + * superclass and documented there.

+ * + * @author Rainer Klute <klute@rainer-klute.de> + */ +@SuppressWarnings("serial") +public class UnexpectedPropertySetTypeException extends HPSFException +{ + + /** + *

Creates an {@link UnexpectedPropertySetTypeException}.

+ */ + public UnexpectedPropertySetTypeException() + { + super(); + } + + + /** + *

Creates an {@link UnexpectedPropertySetTypeException} with a message + * string.

+ * + * @param msg The message string. + */ + public UnexpectedPropertySetTypeException(final String msg) + { + super(msg); + } + + +} Index: /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/UnsupportedVariantTypeException.java =================================================================== --- /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/UnsupportedVariantTypeException.java (revision 28000) +++ /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/UnsupportedVariantTypeException.java (revision 28000) @@ -0,0 +1,57 @@ +/* ==================================================================== + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +==================================================================== */ + +package org.apache.poi.hpsf; + +import org.apache.poi.util.HexDump; + +/** + *

This exception is thrown if HPSF encounters a variant type that isn't + * supported yet. Although a variant type is unsupported the value can still be + * retrieved using the {@link VariantTypeException#getValue} method.

+ * + *

Obviously this class should disappear some day.

+ * + * @author Rainer Klute <klute@rainer-klute.de> + */ +@SuppressWarnings("serial") +public abstract class UnsupportedVariantTypeException +extends VariantTypeException +{ + + /** + *

Constructor.

+ * + * @param variantType The unsupported variant type + * @param value The value who's variant type is not yet supported + */ + public UnsupportedVariantTypeException(final long variantType, + final Object value) + { + super(variantType, value, + "HPSF does not yet support the variant type " + variantType + + " (" + Variant.getVariantName(variantType) + ", " + + HexDump.toHex(variantType) + "). If you want support for " + + "this variant type in one of the next POI releases please " + + "submit a request for enhancement (RFE) to " + + "! Thank you!"); + } + + + +} Index: /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/Util.java =================================================================== --- /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/Util.java (revision 28000) +++ /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/Util.java (revision 28000) @@ -0,0 +1,263 @@ +/* ==================================================================== + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +==================================================================== */ + +package org.apache.poi.hpsf; + +import java.util.Collection; +import java.util.Date; + +/** + *

Provides various static utility methods.

+ * + * @author Rainer Klute (klute@rainer-klute.de) + */ +public class Util +{ + + /** + *

Checks whether two byte arrays a and b + * are equal. They are equal

+ * + *

if they have the same length and
if for each i with + * i >= 0 and + * i < a.length holds + * a[i] == b[i].

+ * + * @param a The first byte array + * @param b The first byte array + * @return true if the byte arrays are equal, else + * false + */ + public static boolean equal(final byte[] a, final byte[] b) + { + if (a.length != b.length) + return false; + for (int i = 0; i < a.length; i++) + if (a[i] != b[i]) + return false; + return true; + } + + + + + /** + *

The difference between the Windows epoch (1601-01-01 + * 00:00:00) and the Unix epoch (1970-01-01 00:00:00) in + * milliseconds: 11644473600000L. (Use your favorite spreadsheet + * program to verify the correctness of this value. By the way, + * did you notice that you can tell from the epochs which + * operating system is the modern one? :-))

+ */ + public static final long EPOCH_DIFF = 11644473600000L; + + + /** + *

Converts a Windows FILETIME into a {@link Date}. The Windows + * FILETIME structure holds a date and time associated with a + * file. The structure identifies a 64-bit integer specifying the + * number of 100-nanosecond intervals which have passed since + * January 1, 1601. This 64-bit value is split into the two double + * words stored in the structure.

+ * + * @param high The higher double word of the FILETIME structure. + * @param low The lower double word of the FILETIME structure. + * @return The Windows FILETIME as a {@link Date}. + */ + public static Date filetimeToDate(final int high, final int low) + { + final long filetime = ((long) high) << 32 | (low & 0xffffffffL); + return filetimeToDate(filetime); + } + + /** + *

+ * + * @param filetime The filetime to convert. + * @return The Windows FILETIME as a {@link Date}. + */ + public static Date filetimeToDate(final long filetime) + { + final long ms_since_16010101 = filetime / (1000 * 10); + final long ms_since_19700101 = ms_since_16010101 - EPOCH_DIFF; + return new Date(ms_since_19700101); + } + + + + /** + *

Converts a {@link Date} into a filetime.

+ * + * @param date The date to be converted + * @return The filetime + * + * @see #filetimeToDate(long) + * @see #filetimeToDate(int, int) + */ + public static long dateToFileTime(final Date date) + { + long ms_since_19700101 = date.getTime(); + long ms_since_16010101 = ms_since_19700101 + EPOCH_DIFF; + return ms_since_16010101 * (1000 * 10); + } + + + /** + *

Checks whether two collections are equal. Two collections + * C₁ and C₂ are equal, if the following conditions + * are true:

+ * + *

For each c_1i (element of C₁) there + * is a c_2j (element of C₂), and + * c_1i equals c_2j.
For each c_2i (element of C₂) there + * is a c_1j (element of C₁) and + * c_2i equals c_1j.

+ * + * @param c1 the first collection + * @param c2 the second collection + * @return true if the collections are equal, else + * false. + */ + public static boolean equals(Collection c1, Collection c2) + { + Object[] o1 = c1.toArray(); + Object[] o2 = c2.toArray(); + return internalEquals(o1, o2); + } + + + + /** + *

Compares to object arrays with regarding the objects' order. For + * example, [1, 2, 3] and [2, 1, 3] are equal.

+ * + * @param c1 The first object array. + * @param c2 The second object array. + * @return true if the object arrays are equal, + * false if they are not. + */ + public static boolean equals(Object[] c1, Object[] c2) + { + final Object[] o1 = c1.clone(); + final Object[] o2 = c2.clone(); + return internalEquals(o1, o2); + } + + private static boolean internalEquals(Object[] o1, Object[] o2) + { + for (int i1 = 0; i1 < o1.length; i1++) + { + final Object obj1 = o1[i1]; + boolean matchFound = false; + for (int i2 = 0; !matchFound && i2 < o1.length; i2++) + { + final Object obj2 = o2[i2]; + if (obj1.equals(obj2)) + { + matchFound = true; + o2[i2] = null; + } + } + if (!matchFound) + return false; + } + return true; + } + + + + /** + *

Pads a byte array with 0x00 bytes so that its length is a multiple of + * 4.

+ * + * @param ba The byte array to pad. + * @return The padded byte array. + */ + public static byte[] pad4(final byte[] ba) + { + final int PAD = 4; + final byte[] result; + int l = ba.length % PAD; + if (l == 0) + result = ba; + else + { + l = PAD - l; + result = new byte[ba.length + l]; + System.arraycopy(ba, 0, result, 0, ba.length); + } + return result; + } + + + + /** + *

Pads a character array with 0x0000 characters so that its length is a + * multiple of 4.

+ * + * @param ca The character array to pad. + * @return The padded character array. + */ + public static char[] pad4(final char[] ca) + { + final int PAD = 4; + final char[] result; + int l = ca.length % PAD; + if (l == 0) + result = ca; + else + { + l = PAD - l; + result = new char[ca.length + l]; + System.arraycopy(ca, 0, result, 0, ca.length); + } + return result; + } + + + + /** + *

Pads a string with 0x0000 characters so that its length is a + * multiple of 4.

+ * + * @param s The string to pad. + * @return The padded string as a character array. + */ + public static char[] pad4(final String s) + { + return pad4(s.toCharArray()); + } + + + +} Index: /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/Variant.java =================================================================== --- /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/Variant.java (revision 28000) +++ /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/Variant.java (revision 28000) @@ -0,0 +1,245 @@ +/* ==================================================================== + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +==================================================================== */ + +package org.apache.poi.hpsf; + +import java.util.Collections; +import java.util.HashMap; +import java.util.Map; + +/** + *

The Variant types as defined by Microsoft's COM. I + * found this information in + * http://www.marin.clara.net/COM/variant_type_definitions.htm.

+ * + *

In the variant types descriptions the following shortcuts are + * used: [V] - may appear in a VARIANT, + * [T] - may appear in a TYPEDESC, + * [P] - may appear in an OLE property set, + * [S] - may appear in a Safe Array.

+ * + * @author Rainer Klute (klute@rainer-klute.de) + */ +public class Variant +{ + + /** + *

[V][P] Nothing, i.e. not a single byte of data.

+ */ + public static final int VT_EMPTY = 0; + + /** + *

[V][T][P][S] 2 byte signed int.

+ */ + public static final int VT_I2 = 2; + + /** + *

[V][T][P][S] 4 byte signed int.

+ */ + public static final int VT_I4 = 3; + + /** + *

[V][T][P][S] 8 byte real.

+ */ + public static final int VT_R8 = 5; + + /** + *

[V][T][P][S] True=-1, False=0.

+ */ + public static final int VT_BOOL = 11; + + /** + *

[T][P] signed 64-bit int.

+ */ + public static final int VT_I8 = 20; + + /** + *

[T][P] null terminated string.

+ */ + public static final int VT_LPSTR = 30; + + /** + *

[T][P] wide (Unicode) null terminated string.

+ */ + public static final int VT_LPWSTR = 31; + + /** + *

[P] FILETIME. The FILETIME structure holds a date and time + * associated with a file. The structure identifies a 64-bit + * integer specifying the number of 100-nanosecond intervals which + * have passed since January 1, 1601. This 64-bit value is split + * into the two dwords stored in the structure.

+ */ + public static final int VT_FILETIME = 64; + + /** + *

[P] Clipboard format. How long is this? How is it to be + * interpreted?

+ */ + public static final int VT_CF = 71; + + /** + *

Maps the numbers denoting the variant types to their corresponding + * variant type names.

+ */ + private static Map numberToName; + + /** + *

Denotes a variant type with a length that is unknown to HPSF yet.

+ */ + public static final Integer LENGTH_UNKNOWN = Integer.valueOf(-2); + + /** + *

Denotes a variant type with a variable length.

+ */ + public static final Integer LENGTH_VARIABLE = Integer.valueOf(-1); + + /** + *

Denotes a variant type with a length of 0 bytes.

+ */ + public static final Integer LENGTH_0 = Integer.valueOf(0); + + /** + *

Denotes a variant type with a length of 2 bytes.

+ */ + public static final Integer LENGTH_2 = Integer.valueOf(2); + + /** + *

Denotes a variant type with a length of 4 bytes.

+ */ + public static final Integer LENGTH_4 = Integer.valueOf(4); + + /** + *

Denotes a variant type with a length of 8 bytes.

+ */ + public static final Integer LENGTH_8 = Integer.valueOf(8); + + + + static + { + /* Initialize the number-to-name map: */ + Map tm1 = new HashMap(); + tm1.put(Long.valueOf(0), "VT_EMPTY"); + tm1.put(Long.valueOf(1), "VT_NULL"); + tm1.put(Long.valueOf(2), "VT_I2"); + tm1.put(Long.valueOf(3), "VT_I4"); + tm1.put(Long.valueOf(4), "VT_R4"); + tm1.put(Long.valueOf(5), "VT_R8"); + tm1.put(Long.valueOf(6), "VT_CY"); + tm1.put(Long.valueOf(7), "VT_DATE"); + tm1.put(Long.valueOf(8), "VT_BSTR"); + tm1.put(Long.valueOf(9), "VT_DISPATCH"); + tm1.put(Long.valueOf(10), "VT_ERROR"); + tm1.put(Long.valueOf(11), "VT_BOOL"); + tm1.put(Long.valueOf(12), "VT_VARIANT"); + tm1.put(Long.valueOf(13), "VT_UNKNOWN"); + tm1.put(Long.valueOf(14), "VT_DECIMAL"); + tm1.put(Long.valueOf(16), "VT_I1"); + tm1.put(Long.valueOf(17), "VT_UI1"); + tm1.put(Long.valueOf(18), "VT_UI2"); + tm1.put(Long.valueOf(19), "VT_UI4"); + tm1.put(Long.valueOf(20), "VT_I8"); + tm1.put(Long.valueOf(21), "VT_UI8"); + tm1.put(Long.valueOf(22), "VT_INT"); + tm1.put(Long.valueOf(23), "VT_UINT"); + tm1.put(Long.valueOf(24), "VT_VOID"); + tm1.put(Long.valueOf(25), "VT_HRESULT"); + tm1.put(Long.valueOf(26), "VT_PTR"); + tm1.put(Long.valueOf(27), "VT_SAFEARRAY"); + tm1.put(Long.valueOf(28), "VT_CARRAY"); + tm1.put(Long.valueOf(29), "VT_USERDEFINED"); + tm1.put(Long.valueOf(30), "VT_LPSTR"); + tm1.put(Long.valueOf(31), "VT_LPWSTR"); + tm1.put(Long.valueOf(64), "VT_FILETIME"); + tm1.put(Long.valueOf(65), "VT_BLOB"); + tm1.put(Long.valueOf(66), "VT_STREAM"); + tm1.put(Long.valueOf(67), "VT_STORAGE"); + tm1.put(Long.valueOf(68), "VT_STREAMED_OBJECT"); + tm1.put(Long.valueOf(69), "VT_STORED_OBJECT"); + tm1.put(Long.valueOf(70), "VT_BLOB_OBJECT"); + tm1.put(Long.valueOf(71), "VT_CF"); + tm1.put(Long.valueOf(72), "VT_CLSID"); + Map tm2 = new HashMap(tm1.size(), 1.0F); + tm2.putAll(tm1); + numberToName = Collections.unmodifiableMap(tm2); + + /* Initialize the number-to-length map: */ + tm1.clear(); + tm1.put(Long.valueOf(0), LENGTH_0); + tm1.put(Long.valueOf(1), LENGTH_UNKNOWN); + tm1.put(Long.valueOf(2), LENGTH_2); + tm1.put(Long.valueOf(3), LENGTH_4); + tm1.put(Long.valueOf(4), LENGTH_4); + tm1.put(Long.valueOf(5), LENGTH_8); + tm1.put(Long.valueOf(6), LENGTH_UNKNOWN); + tm1.put(Long.valueOf(7), LENGTH_UNKNOWN); + tm1.put(Long.valueOf(8), LENGTH_UNKNOWN); + tm1.put(Long.valueOf(9), LENGTH_UNKNOWN); + tm1.put(Long.valueOf(10), LENGTH_UNKNOWN); + tm1.put(Long.valueOf(11), LENGTH_UNKNOWN); + tm1.put(Long.valueOf(12), LENGTH_UNKNOWN); + tm1.put(Long.valueOf(13), LENGTH_UNKNOWN); + tm1.put(Long.valueOf(14), LENGTH_UNKNOWN); + tm1.put(Long.valueOf(16), LENGTH_UNKNOWN); + tm1.put(Long.valueOf(17), LENGTH_UNKNOWN); + tm1.put(Long.valueOf(18), LENGTH_UNKNOWN); + tm1.put(Long.valueOf(19), LENGTH_UNKNOWN); + tm1.put(Long.valueOf(20), LENGTH_UNKNOWN); + tm1.put(Long.valueOf(21), LENGTH_UNKNOWN); + tm1.put(Long.valueOf(22), LENGTH_UNKNOWN); + tm1.put(Long.valueOf(23), LENGTH_UNKNOWN); + tm1.put(Long.valueOf(24), LENGTH_UNKNOWN); + tm1.put(Long.valueOf(25), LENGTH_UNKNOWN); + tm1.put(Long.valueOf(26), LENGTH_UNKNOWN); + tm1.put(Long.valueOf(27), LENGTH_UNKNOWN); + tm1.put(Long.valueOf(28), LENGTH_UNKNOWN); + tm1.put(Long.valueOf(29), LENGTH_UNKNOWN); + tm1.put(Long.valueOf(30), LENGTH_VARIABLE); + tm1.put(Long.valueOf(31), LENGTH_UNKNOWN); + tm1.put(Long.valueOf(64), LENGTH_8); + tm1.put(Long.valueOf(65), LENGTH_UNKNOWN); + tm1.put(Long.valueOf(66), LENGTH_UNKNOWN); + tm1.put(Long.valueOf(67), LENGTH_UNKNOWN); + tm1.put(Long.valueOf(68), LENGTH_UNKNOWN); + tm1.put(Long.valueOf(69), LENGTH_UNKNOWN); + tm1.put(Long.valueOf(70), LENGTH_UNKNOWN); + tm1.put(Long.valueOf(71), LENGTH_UNKNOWN); + tm1.put(Long.valueOf(72), LENGTH_UNKNOWN); + tm2 = new HashMap(tm1.size(), 1.0F); + tm2.putAll(tm1); + } + + + + /** + *

Returns the variant type name associated with a variant type + * number.

+ * + * @param variantType The variant type number + * @return The variant type name or the string "unknown variant type" + */ + public static String getVariantName(final long variantType) + { + final String name = (String) numberToName.get(Long.valueOf(variantType)); + return name != null ? name : "unknown variant type"; + } + + +} Index: /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/VariantSupport.java =================================================================== --- /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/VariantSupport.java (revision 28000) +++ /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/VariantSupport.java (revision 28000) @@ -0,0 +1,555 @@ +/* ==================================================================== + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +==================================================================== */ + +package org.apache.poi.hpsf; + +import java.io.IOException; +import java.io.OutputStream; +import java.io.UnsupportedEncodingException; +import java.util.Date; +import java.util.LinkedList; +import java.util.List; + +import org.apache.poi.util.LittleEndian; +import org.apache.poi.util.LittleEndianConsts; + +/** + *

Supports reading and writing of variant data.

+ * + *

FIXME (3): Reading and writing should be made more + * uniform than it is now. The following items should be resolved: + * + *

Reading requires a length parameter that is 4 byte greater than the + * actual data, because the variant type field is included.
Reading reads from a byte array while writing writes to an byte array + * output stream.

+ * + * @author Rainer Klute <klute@rainer-klute.de> + */ +public class VariantSupport extends Variant +{ + + private static boolean logUnsupportedTypes = false; + + + + /** + *

Checks whether logging of unsupported variant types warning is turned + * on or off.

+ * + * @return true if logging is turned on, else + * false. + */ + public static boolean isLogUnsupportedTypes() + { + return logUnsupportedTypes; + } + + + + /** + *

Keeps a list of the variant types an "unsupported" message has already + * been issued for.

+ */ + protected static List unsupportedMessage; + + /** + *

Writes a warning to System.err that a variant type is + * unsupported by HPSF. Such a warning is written only once for each variant + * type. Log messages can be turned on or off by

+ * + * @param ex The exception to log + */ + protected static void writeUnsupportedTypeMessage + (final UnsupportedVariantTypeException ex) + { + if (isLogUnsupportedTypes()) + { + if (unsupportedMessage == null) + unsupportedMessage = new LinkedList(); + Long vt = Long.valueOf(ex.getVariantType()); + if (!unsupportedMessage.contains(vt)) + { + System.err.println(ex.getMessage()); + unsupportedMessage.add(vt); + } + } + } + + /** + *

Reads a variant type from a byte array.

+ * + * @param src The byte array + * @param offset The offset in the byte array where the variant starts + * @param length The length of the variant including the variant type field + * @param type The variant type to read + * @param codepage The codepage to use for non-wide strings + * @return A Java object that corresponds best to the variant field. For + * example, a VT_I4 is returned as a {@link Long}, a VT_LPSTR as a + * {@link String}. + * @exception ReadingNotSupportedException if a property is to be written + * who's variant type HPSF does not yet support + * @exception UnsupportedEncodingException if the specified codepage is not + * supported. + * @see Variant + */ + public static Object read(final byte[] src, final int offset, + final int length, final long type, + final int codepage) + throws ReadingNotSupportedException, UnsupportedEncodingException + { + Object value; + int o1 = offset; + int l1 = length - LittleEndian.INT_SIZE; + long lType = type; + + /* Instead of trying to read 8-bit characters from a Unicode string, + * read 16-bit characters. */ + if (codepage == Constants.CP_UNICODE && type == Variant.VT_LPSTR) + lType = Variant.VT_LPWSTR; + + switch ((int) lType) + { + case Variant.VT_EMPTY: + { + value = null; + break; + } + case Variant.VT_I2: + { + /* + * Read a short. In Java it is represented as an + * Integer object. + */ + value = Integer.valueOf(LittleEndian.getShort(src, o1)); + break; + } + case Variant.VT_I4: + { + /* + * Read a word. In Java it is represented as an + * Integer object. + */ + value = Integer.valueOf(LittleEndian.getInt(src, o1)); + break; + } + case Variant.VT_I8: + { + /* + * Read a double word. In Java it is represented as a + * Long object. + */ + value = Long.valueOf(LittleEndian.getLong(src, o1)); + break; + } + case Variant.VT_R8: + { + /* + * Read an eight-byte double value. In Java it is represented as + * a Double object. + */ + value = new Double(LittleEndian.getDouble(src, o1)); + break; + } + case Variant.VT_FILETIME: + { + /* + * Read a FILETIME object. In Java it is represented + * as a Date object. + */ + final long low = LittleEndian.getUInt(src, o1); + o1 += LittleEndian.INT_SIZE; + final long high = LittleEndian.getUInt(src, o1); + value = Util.filetimeToDate((int) high, (int) low); + break; + } + case Variant.VT_LPSTR: + { + /* + * Read a byte string. In Java it is represented as a + * String object. The 0x00 bytes at the end must be + * stripped. + */ + final int first = o1 + LittleEndian.INT_SIZE; + long last = first + LittleEndian.getUInt(src, o1) - 1; + o1 += LittleEndian.INT_SIZE; + while (src[(int) last] == 0 && first <= last) + last--; + final int l = (int) (last - first + 1); + value = codepage != -1 ? + new String(src, first, l, + codepageToEncoding(codepage)) : + new String(src, first, l); + break; + } + case Variant.VT_LPWSTR: + { + /* + * Read a Unicode string. In Java it is represented as + * a String object. The 0x00 bytes at the end must be + * stripped. + */ + final int first = o1 + LittleEndian.INT_SIZE; + long last = first + LittleEndian.getUInt(src, o1) - 1; + long l = last - first; + o1 += LittleEndian.INT_SIZE; + StringBuffer b = new StringBuffer((int) (last - first)); + for (int i = 0; i <= l; i++) + { + final int i1 = o1 + (i * 2); + final int i2 = i1 + 1; + final int high = src[i2] << 8; + final int low = src[i1] & 0x00ff; + final char c = (char) (high | low); + b.append(c); + } + /* Strip 0x00 characters from the end of the string: */ + while (b.length() > 0 && b.charAt(b.length() - 1) == 0x00) + b.setLength(b.length() - 1); + value = b.toString(); + break; + } + case Variant.VT_CF: + { + if(l1 < 0) { + /** + * YK: reading the ClipboardData packet (VT_CF) is not quite correct. + * The size of the data is determined by the first four bytes of the packet + * while the current implementation calculates it in the Section constructor. + * Test files in Bugzilla 42726 and 45583 clearly show that this approach does not always work. + * The workaround below attempts to gracefully handle such cases instead of throwing exceptions. + * + * August 20, 2009 + */ + l1 = LittleEndian.getInt(src, o1); o1 += LittleEndian.INT_SIZE; + } + final byte[] v = new byte[l1]; + System.arraycopy(src, o1, v, 0, v.length); + value = v; + break; + } + case Variant.VT_BOOL: + { + /* + * The first four bytes in src, from src[offset] to + * src[offset + 3] contain the DWord for VT_BOOL, so + * skip it, we don't need it. + */ + // final int first = offset + LittleEndian.INT_SIZE; + long bool = LittleEndian.getUInt(src, o1); + if (bool != 0) + value = Boolean.TRUE; + else + value = Boolean.FALSE; + break; + } + default: + { + final byte[] v = new byte[l1]; + for (int i = 0; i < l1; i++) + v[i] = src[(o1 + i)]; + throw new ReadingNotSupportedException(type, v); + } + } + return value; + } + + + + /** + *

Turns a codepage number into the equivalent character encoding's + * name.

+ * + * @param codepage The codepage number + * + * @return The character encoding's name. If the codepage number is 65001, + * the encoding name is "UTF-8". All other positive numbers are mapped to + * "cp" followed by the number, e.g. if the codepage number is 1252 the + * returned character encoding name will be "cp1252". + * + * @exception UnsupportedEncodingException if the specified codepage is + * less than zero. + */ + public static String codepageToEncoding(final int codepage) + throws UnsupportedEncodingException + { + if (codepage <= 0) + throw new UnsupportedEncodingException + ("Codepage number may not be " + codepage); + switch (codepage) + { + case Constants.CP_UTF16: + return "UTF-16"; + case Constants.CP_UTF16_BE: + return "UTF-16BE"; + case Constants.CP_UTF8: + return "UTF-8"; + case Constants.CP_037: + return "cp037"; + case Constants.CP_GBK: + return "GBK"; + case Constants.CP_MS949: + return "ms949"; + case Constants.CP_WINDOWS_1250: + return "windows-1250"; + case Constants.CP_WINDOWS_1251: + return "windows-1251"; + case Constants.CP_WINDOWS_1252: + return "windows-1252"; + case Constants.CP_WINDOWS_1253: + return "windows-1253"; + case Constants.CP_WINDOWS_1254: + return "windows-1254"; + case Constants.CP_WINDOWS_1255: + return "windows-1255"; + case Constants.CP_WINDOWS_1256: + return "windows-1256"; + case Constants.CP_WINDOWS_1257: + return "windows-1257"; + case Constants.CP_WINDOWS_1258: + return "windows-1258"; + case Constants.CP_JOHAB: + return "johab"; + case Constants.CP_MAC_ROMAN: + return "MacRoman"; + case Constants.CP_MAC_JAPAN: + return "SJIS"; + case Constants.CP_MAC_CHINESE_TRADITIONAL: + return "Big5"; + case Constants.CP_MAC_KOREAN: + return "EUC-KR"; + case Constants.CP_MAC_ARABIC: + return "MacArabic"; + case Constants.CP_MAC_HEBREW: + return "MacHebrew"; + case Constants.CP_MAC_GREEK: + return "MacGreek"; + case Constants.CP_MAC_CYRILLIC: + return "MacCyrillic"; + case Constants.CP_MAC_CHINESE_SIMPLE: + return "EUC_CN"; + case Constants.CP_MAC_ROMANIA: + return "MacRomania"; + case Constants.CP_MAC_UKRAINE: + return "MacUkraine"; + case Constants.CP_MAC_THAI: + return "MacThai"; + case Constants.CP_MAC_CENTRAL_EUROPE: + return "MacCentralEurope"; + case Constants.CP_MAC_ICELAND: + return "MacIceland"; + case Constants.CP_MAC_TURKISH: + return "MacTurkish"; + case Constants.CP_MAC_CROATIAN: + return "MacCroatian"; + case Constants.CP_US_ACSII: + case Constants.CP_US_ASCII2: + return "US-ASCII"; + case Constants.CP_KOI8_R: + return "KOI8-R"; + case Constants.CP_ISO_8859_1: + return "ISO-8859-1"; + case Constants.CP_ISO_8859_2: + return "ISO-8859-2"; + case Constants.CP_ISO_8859_3: + return "ISO-8859-3"; + case Constants.CP_ISO_8859_4: + return "ISO-8859-4"; + case Constants.CP_ISO_8859_5: + return "ISO-8859-5"; + case Constants.CP_ISO_8859_6: + return "ISO-8859-6"; + case Constants.CP_ISO_8859_7: + return "ISO-8859-7"; + case Constants.CP_ISO_8859_8: + return "ISO-8859-8"; + case Constants.CP_ISO_8859_9: + return "ISO-8859-9"; + case Constants.CP_ISO_2022_JP1: + case Constants.CP_ISO_2022_JP2: + case Constants.CP_ISO_2022_JP3: + return "ISO-2022-JP"; + case Constants.CP_ISO_2022_KR: + return "ISO-2022-KR"; + case Constants.CP_EUC_JP: + return "EUC-JP"; + case Constants.CP_EUC_KR: + return "EUC-KR"; + case Constants.CP_GB2312: + return "GB2312"; + case Constants.CP_GB18030: + return "GB18030"; + case Constants.CP_SJIS: + return "SJIS"; + default: + return "cp" + codepage; + } + } + + + /** + *

Writes a variant value to an output stream. This method ensures that + * always a multiple of 4 bytes is written.

+ * + *

If the codepage is UTF-16, which is encouraged, strings + * must always be written as {@link Variant#VT_LPWSTR} + * strings, not as {@link Variant#VT_LPSTR} strings. This method ensure this + * by converting strings appropriately, if needed.

+ * + * @param out The stream to write the value to. + * @param type The variant's type. + * @param value The variant's value. + * @param codepage The codepage to use to write non-wide strings + * @return The number of entities that have been written. In many cases an + * "entity" is a byte but this is not always the case. + * @exception IOException if an I/O exceptions occurs + * @exception WritingNotSupportedException if a property is to be written + * who's variant type HPSF does not yet support + */ + public static int write(final OutputStream out, final long type, + final Object value, final int codepage) + throws IOException, WritingNotSupportedException + { + int length = 0; + switch ((int) type) + { + case Variant.VT_BOOL: + { + int trueOrFalse; + if (((Boolean) value).booleanValue()) + trueOrFalse = 1; + else + trueOrFalse = 0; + length = TypeWriter.writeUIntToStream(out, trueOrFalse); + break; + } + case Variant.VT_LPSTR: + { + final byte[] bytes = + (codepage == -1 ? + ((String) value).getBytes() : + ((String) value).getBytes(codepageToEncoding(codepage))); + length = TypeWriter.writeUIntToStream(out, bytes.length + 1); + final byte[] b = new byte[bytes.length + 1]; + System.arraycopy(bytes, 0, b, 0, bytes.length); + b[b.length - 1] = 0x00; + out.write(b); + length += b.length; + break; + } + case Variant.VT_LPWSTR: + { + final int nrOfChars = ((String) value).length() + 1; + length += TypeWriter.writeUIntToStream(out, nrOfChars); + char[] s = Util.pad4((String) value); + for (int i = 0; i < s.length; i++) + { + final int high = ((s[i] & 0x0000ff00) >> 8); + final int low = (s[i] & 0x000000ff); + final byte highb = (byte) high; + final byte lowb = (byte) low; + out.write(lowb); + out.write(highb); + length += 2; + } + out.write(0x00); + out.write(0x00); + length += 2; + break; + } + case Variant.VT_CF: + { + final byte[] b = (byte[]) value; + out.write(b); + length = b.length; + break; + } + case Variant.VT_EMPTY: + { + TypeWriter.writeUIntToStream(out, Variant.VT_EMPTY); + length = LittleEndianConsts.INT_SIZE; + break; + } + case Variant.VT_I2: + { + TypeWriter.writeToStream(out, ((Integer) value).shortValue()); + length = LittleEndianConsts.SHORT_SIZE; + break; + } + case Variant.VT_I4: + { + if (!(value instanceof Integer)) + { + throw new ClassCastException("Could not cast an object to " + + Integer.class.toString() + ": " + + value.getClass().toString() + ", " + + value.toString()); + } + length += TypeWriter.writeToStream(out, + ((Integer) value).intValue()); + break; + } + case Variant.VT_I8: + { + TypeWriter.writeToStream(out, ((Long) value).longValue()); + length = LittleEndianConsts.LONG_SIZE; + break; + } + case Variant.VT_R8: + { + length += TypeWriter.writeToStream(out, + ((Double) value).doubleValue()); + break; + } + case Variant.VT_FILETIME: + { + long filetime = Util.dateToFileTime((Date) value); + int high = (int) ((filetime >> 32) & 0x00000000FFFFFFFFL); + int low = (int) (filetime & 0x00000000FFFFFFFFL); + length += TypeWriter.writeUIntToStream + (out, 0x0000000FFFFFFFFL & low); + length += TypeWriter.writeUIntToStream + (out, 0x0000000FFFFFFFFL & high); + break; + } + default: + { + /* The variant type is not supported yet. However, if the value + * is a byte array we can write it nevertheless. */ + if (value instanceof byte[]) + { + final byte[] b = (byte[]) value; + out.write(b); + length = b.length; + writeUnsupportedTypeMessage + (new WritingNotSupportedException(type, value)); + } + else + throw new WritingNotSupportedException(type, value); + break; + } + } + + return length; + } +} Index: /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/VariantTypeException.java =================================================================== --- /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/VariantTypeException.java (revision 28000) +++ /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/VariantTypeException.java (revision 28000) @@ -0,0 +1,76 @@ +/* ==================================================================== + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +==================================================================== */ + +package org.apache.poi.hpsf; + +/** + *

This exception is thrown if HPSF encounters a problem with a variant type. + * Concrete subclasses specifiy the problem further.

+ * + * @author Rainer Klute <klute@rainer-klute.de> + */ +@SuppressWarnings("serial") +public abstract class VariantTypeException extends HPSFException +{ + + private Object value; + + private long variantType; + + + + /** + *

Constructor.

+ * + * @param variantType The variant type causing the problem + * @param value The value who's variant type causes the problem + * @param msg A message text describing the problem + */ + public VariantTypeException(final long variantType, final Object value, + final String msg) + { + super(msg); + this.variantType = variantType; + this.value = value; + } + + + + /** + *

Returns the offending variant type.

+ * + * @return the offending variant type. + */ + public long getVariantType() + { + return variantType; + } + + + + /** + *

Returns the value who's variant type caused the problem.

+ * + * @return the value who's variant type caused the problem + */ + public Object getValue() + { + return value; + } + +} Index: /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/WritingNotSupportedException.java =================================================================== --- /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/WritingNotSupportedException.java (revision 28000) +++ /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/WritingNotSupportedException.java (revision 28000) @@ -0,0 +1,47 @@ +/* ==================================================================== + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +==================================================================== */ + +package org.apache.poi.hpsf; + +/** + *

This exception is thrown when trying to write a (yet) unsupported variant + * type.

+ * + * @see ReadingNotSupportedException + * @see UnsupportedVariantTypeException + * + * @author Rainer Klute <klute@rainer-klute.de> + */ +@SuppressWarnings("serial") +public class WritingNotSupportedException + extends UnsupportedVariantTypeException +{ + + /** + *

Constructor

+ * + * @param variantType The unsupported variant type. + * @param value The value. + */ + public WritingNotSupportedException(final long variantType, + final Object value) + { + super(variantType, value); + } + +} Index: /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/package.html =================================================================== --- /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/package.html (revision 28000) +++ /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/package.html (revision 28000) @@ -0,0 +1,164 @@ + + + + + HPSF + + + +

Processes streams in the Horrible Property Set Format (HPSF) in POI + filesystems. Microsoft Office documents, i.e. POI filesystems, usually + contain meta data like author, title, last saving time etc. These items + are called properties and stored in + property set streams along with the document itself. These + streams are commonly named \005SummaryInformation and + \005DocumentSummaryInformation. However, a POI filesystem may + contain further property sets of other names or types.

+ +

In order to extract the properties from a POI filesystem, a property set + stream's contents must be parsed into a {@link + org.apache.poi.hpsf.PropertySet} instance. Its subclasses {@link + org.apache.poi.hpsf.SummaryInformation} and {@link + org.apache.poi.hpsf.DocumentSummaryInformation} deal with the well-known + property set streams \005SummaryInformation and + \005DocumentSummaryInformation. (However, the streams' names are + irrelevant. What counts is the property set's first section's format ID - + see below.)

+ +

The factory method {@link org.apache.poi.hpsf.PropertySetFactory#create} + creates a {@link org.apache.poi.hpsf.PropertySet} instance. This method + always returns the most specific property set: If it + identifies the stream data as a Summary Information or as a Document + Summary Information it returns an instance of the corresponding class, else + the general {@link org.apache.poi.hpsf.PropertySet}.

+ +

A {@link org.apache.poi.hpsf.PropertySet} contains a list of {@link + org.apache.poi.hpsf.Section}s which can be retrieved with {@link + org.apache.poi.hpsf.PropertySet#getSections}. Each {@link + org.apache.poi.hpsf.Section} contains a {@link + org.apache.poi.hpsf.Property} array which can be retrieved with {@link + org.apache.poi.hpsf.Section#getProperties}. Since the vast majority of + {@link org.apache.poi.hpsf.PropertySet}s contains only a single {@link + org.apache.poi.hpsf.Section}, the convenience method {@link + org.apache.poi.hpsf.PropertySet#getProperties} returns the properties of a + {@link org.apache.poi.hpsf.PropertySet}'s {@link + org.apache.poi.hpsf.Section} (throwing a {@link + org.apache.poi.hpsf.NoSingleSectionException} if the {@link + org.apache.poi.hpsf.PropertySet} contains more (or less) than exactly one + {@link org.apache.poi.hpsf.Section}).

+ +

Each {@link org.apache.poi.hpsf.Property} has an ID, a + type, and a value which can be retrieved + with {@link org.apache.poi.hpsf.Property#getID}, {@link + org.apache.poi.hpsf.Property#getType}, and {@link + org.apache.poi.hpsf.Property#getValue}, respectively. The value's class + depends on the property's type. The current implementation + does not yet support all property types and restricts the values' classes + to {@link java.lang.String}, {@link java.lang.Integer} and {@link + java.util.Date}. A value of a yet unknown type is returned as a byte array + containing the value's origin bytes from the property set stream.

+ +

To retrieve the value of a specific {@link org.apache.poi.hpsf.Property}, + use {@link org.apache.poi.hpsf.Section#getProperty} or {@link + org.apache.poi.hpsf.Section#getPropertyIntValue}.

+ +

The {@link org.apache.poi.hpsf.SummaryInformation} and {@link + org.apache.poi.hpsf.DocumentSummaryInformation} classes provide convenience + methods for retrieving well-known properties. For example, an application + that wants to retrieve a document's title string just calls {@link + org.apache.poi.hpsf.SummaryInformation#getTitle} instead of going through + the hassle of first finding out what the title's property ID is and then + using this ID to get the property's value.

+ +

Writing properties can be done with the classes + {@link org.apache.poi.hpsf.MutablePropertySet}, {@link + org.apache.poi.hpsf.MutableSection}, and {@link + org.apache.poi.hpsf.MutableProperty}.

+ +

Public documentation from Microsoft can be found in the appropriate section of the MSDN Library.

+ +

History

+ +

2003-09-11:: +
{@link org.apache.poi.hpsf.PropertySetFactory#create(InputStream)} no + longer throws an + {@link org.apache.poi.hpsf.UnexpectedPropertySetTypeException}.

+ + +

To Do

+ +

The following is still left to be implemented. Sponsering could foster + these issues considerably.

+ +

+
Convenience methods for setting summary information and document + summary information properties
+
+
Better codepage support
+
+
Support for more property (variant) types
+

+ +

+ @author Rainer Klute (klute@rainer-klute.de) +

+ + + + + Index: /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/wellknown/PropertyIDMap.java =================================================================== --- /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/wellknown/PropertyIDMap.java (revision 28000) +++ /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/wellknown/PropertyIDMap.java (revision 28000) @@ -0,0 +1,363 @@ +/* ==================================================================== + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +==================================================================== */ + +package org.apache.poi.hpsf.wellknown; + +import java.util.Collections; +import java.util.HashMap; +import java.util.Map; + +/** + *

This is a dictionary which maps property ID values to property + * ID strings.

+ * + *

The methods {@link #getSummaryInformationProperties} and {@link + * #getDocumentSummaryInformationProperties} return singleton {@link + * PropertyIDMap}s. An application that wants to extend these maps + * should treat them as unmodifiable, copy them and modifiy the + * copies.

+ * + * @author Rainer Klute <klute@rainer-klute.de> + */ +@SuppressWarnings("serial") +public class PropertyIDMap extends HashMap { + + /* + * The following definitions are for property IDs in the first + * (and only) section of the Summary Information property set. + */ + + /**

ID of the property that denotes the document's title

*/ + public static final int PID_TITLE = 2; + + /**

ID of the property that denotes the document's subject

*/ + public static final int PID_SUBJECT = 3; + + /**

ID of the property that denotes the document's author

*/ + public static final int PID_AUTHOR = 4; + + /**

ID of the property that denotes the document's keywords

*/ + public static final int PID_KEYWORDS = 5; + + /**

ID of the property that denotes the document's comments

*/ + public static final int PID_COMMENTS = 6; + + /**

ID of the property that denotes the document's template

*/ + public static final int PID_TEMPLATE = 7; + + /**

ID of the property that denotes the document's last author

*/ + public static final int PID_LASTAUTHOR = 8; + + /**

ID of the property that denotes the document's revision number

*/ + public static final int PID_REVNUMBER = 9; + + /**

ID of the property that denotes the document's edit time

*/ + public static final int PID_EDITTIME = 10; + + /**

ID of the property that denotes the date and time the document was + * last printed

*/ + public static final int PID_LASTPRINTED = 11; + + /**

ID of the property that denotes the date and time the document was + * created.

*/ + public static final int PID_CREATE_DTM = 12; + + /**

ID of the property that denotes the date and time the document was + * saved

*/ + public static final int PID_LASTSAVE_DTM = 13; + + /**

ID of the property that denotes the number of pages in the + * document

*/ + public static final int PID_PAGECOUNT = 14; + + /**

ID of the property that denotes the number of words in the + * document

*/ + public static final int PID_WORDCOUNT = 15; + + /**

ID of the property that denotes the number of characters in the + * document

*/ + public static final int PID_CHARCOUNT = 16; + + /**

ID of the property that denotes the document's thumbnail

*/ + public static final int PID_THUMBNAIL = 17; + + /**

ID of the property that denotes the application that created the + * document

*/ + public static final int PID_APPNAME = 18; + + /**

ID of the property that denotes whether read/write access to the + * document is allowed or whether is should be opened as read-only. It can + * have the following values:

+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *

Value	Description
0	No restriction
2	Read-only recommended
4	Read-only enforced

+ */ + public static final int PID_SECURITY = 19; + + + + /* + * The following definitions are for property IDs in the first + * section of the Document Summary Information property set. + */ + + /** + *

The entry is a dictionary.

+ */ + public static final int PID_DICTIONARY = 0; + + /** + *

The entry denotes a code page.

+ */ + public static final int PID_CODEPAGE = 1; + + /** + *

The entry is a string denoting the category the file belongs + * to, e.g. review, memo, etc. This is useful to find documents of + * same type.

+ */ + public static final int PID_CATEGORY = 2; + + /** + *

Target format for power point presentation, e.g. 35mm, + * printer, video etc.

+ */ + public static final int PID_PRESFORMAT = 3; + + /** + *

Number of bytes.

+ */ + public static final int PID_BYTECOUNT = 4; + + /** + *

Number of lines.

+ */ + public static final int PID_LINECOUNT = 5; + + /** + *

Number of paragraphs.

+ */ + public static final int PID_PARCOUNT = 6; + + /** + *

Number of slides in a power point presentation.

+ */ + public static final int PID_SLIDECOUNT = 7; + + /** + *

Number of slides with notes.

+ */ + public static final int PID_NOTECOUNT = 8; + + /** + *

Number of hidden slides.

+ */ + public static final int PID_HIDDENCOUNT = 9; + + /** + *

Number of multimedia clips, e.g. sound or video.

+ */ + public static final int PID_MMCLIPCOUNT = 10; + + /** + *

This entry is set to -1 when scaling of the thumbnail is + * desired. Otherwise the thumbnail should be cropped.

+ */ + public static final int PID_SCALE = 11; + + /** + *

This entry denotes an internally used property. It is a + * vector of variants consisting of pairs of a string (VT_LPSTR) + * and a number (VT_I4). The string is a heading name, and the + * number tells how many document parts are under that + * heading.

+ */ + public static final int PID_HEADINGPAIR = 12; + + /** + *

This entry contains the names of document parts (word: names + * of the documents in the master document, excel: sheet names, + * power point: slide titles, binder: document names).

+ */ + public static final int PID_DOCPARTS = 13; + + /** + *

This entry contains the name of the project manager.

+ */ + public static final int PID_MANAGER = 14; + + /** + *

This entry contains the company name.

+ */ + public static final int PID_COMPANY = 15; + + /** + *

If this entry is -1 the links are dirty and should be + * re-evaluated.

+ */ + public static final int PID_LINKSDIRTY = 16; + + /** + *

Contains the summary information property ID values and + * associated strings. See the overall HPSF documentation for + * details!

+ */ + private static PropertyIDMap summaryInformationProperties; + + /** + *

Contains the summary information property ID values and + * associated strings. See the overall HPSF documentation for + * details!

+ */ + private static PropertyIDMap documentSummaryInformationProperties; + + + + /** + *

Creates a {@link PropertyIDMap}.

+ * + * @param initialCapacity The initial capacity as defined for + * {@link HashMap} + * @param loadFactor The load factor as defined for {@link HashMap} + */ + public PropertyIDMap(final int initialCapacity, final float loadFactor) + { + super(initialCapacity, loadFactor); + } + + + + /** + *

Creates a {@link PropertyIDMap} backed by another map.

+ * + * @param map The instance to be created is backed by this map. + */ + public PropertyIDMap(final Map map) + { + super(map); + } + + + + /** + *

Puts a ID string for an ID into the {@link + * PropertyIDMap}.

+ * + * @param id The ID. + * @param idString The ID string. + * @return As specified by the {@link java.util.Map} interface, this method + * returns the previous value associated with the specified + * id, or null if there was no mapping for + * key. + */ + public Object put(final long id, final String idString) + { + return put(Long.valueOf(id), idString); + } + + + + + + + /** + * @return the Summary Information properties singleton + */ + public static PropertyIDMap getSummaryInformationProperties() + { + if (summaryInformationProperties == null) + { + PropertyIDMap m = new PropertyIDMap(18, (float) 1.0); + m.put(PID_TITLE, "PID_TITLE"); + m.put(PID_SUBJECT, "PID_SUBJECT"); + m.put(PID_AUTHOR, "PID_AUTHOR"); + m.put(PID_KEYWORDS, "PID_KEYWORDS"); + m.put(PID_COMMENTS, "PID_COMMENTS"); + m.put(PID_TEMPLATE, "PID_TEMPLATE"); + m.put(PID_LASTAUTHOR, "PID_LASTAUTHOR"); + m.put(PID_REVNUMBER, "PID_REVNUMBER"); + m.put(PID_EDITTIME, "PID_EDITTIME"); + m.put(PID_LASTPRINTED, "PID_LASTPRINTED"); + m.put(PID_CREATE_DTM, "PID_CREATE_DTM"); + m.put(PID_LASTSAVE_DTM, "PID_LASTSAVE_DTM"); + m.put(PID_PAGECOUNT, "PID_PAGECOUNT"); + m.put(PID_WORDCOUNT, "PID_WORDCOUNT"); + m.put(PID_CHARCOUNT, "PID_CHARCOUNT"); + m.put(PID_THUMBNAIL, "PID_THUMBNAIL"); + m.put(PID_APPNAME, "PID_APPNAME"); + m.put(PID_SECURITY, "PID_SECURITY"); + summaryInformationProperties = + new PropertyIDMap(Collections.unmodifiableMap(m)); + } + return summaryInformationProperties; + } + + + + /** + *

Returns the Document Summary Information properties + * singleton.

+ * + * @return The Document Summary Information properties singleton. + */ + public static PropertyIDMap getDocumentSummaryInformationProperties() + { + if (documentSummaryInformationProperties == null) + { + PropertyIDMap m = new PropertyIDMap(17, (float) 1.0); + m.put(PID_DICTIONARY, "PID_DICTIONARY"); + m.put(PID_CODEPAGE, "PID_CODEPAGE"); + m.put(PID_CATEGORY, "PID_CATEGORY"); + m.put(PID_PRESFORMAT, "PID_PRESFORMAT"); + m.put(PID_BYTECOUNT, "PID_BYTECOUNT"); + m.put(PID_LINECOUNT, "PID_LINECOUNT"); + m.put(PID_PARCOUNT, "PID_PARCOUNT"); + m.put(PID_SLIDECOUNT, "PID_SLIDECOUNT"); + m.put(PID_NOTECOUNT, "PID_NOTECOUNT"); + m.put(PID_HIDDENCOUNT, "PID_HIDDENCOUNT"); + m.put(PID_MMCLIPCOUNT, "PID_MMCLIPCOUNT"); + m.put(PID_SCALE, "PID_SCALE"); + m.put(PID_HEADINGPAIR, "PID_HEADINGPAIR"); + m.put(PID_DOCPARTS, "PID_DOCPARTS"); + m.put(PID_MANAGER, "PID_MANAGER"); + m.put(PID_COMPANY, "PID_COMPANY"); + m.put(PID_LINKSDIRTY, "PID_LINKSDIRTY"); + documentSummaryInformationProperties = + new PropertyIDMap(Collections.unmodifiableMap(m)); + } + return documentSummaryInformationProperties; + } +} Index: /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/wellknown/SectionIDMap.java =================================================================== --- /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/wellknown/SectionIDMap.java (revision 28000) +++ /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/wellknown/SectionIDMap.java (revision 28000) @@ -0,0 +1,70 @@ +/* ==================================================================== + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +==================================================================== */ + +package org.apache.poi.hpsf.wellknown; + + +/** + *

Maps section format IDs to {@link PropertyIDMap}s. It is + * initialized with two well-known section format IDs: those of the + * \005SummaryInformation stream and the + * \005DocumentSummaryInformation stream.

+ * + *

If you have a section format ID you can use it as a key to query + * this map. If you get a {@link PropertyIDMap} returned your section + * is well-known and you can query the {@link PropertyIDMap} for PID + * strings. If you get back null you are on your own.

+ * + *

This {@link java.util.Map} expects the byte arrays of section format IDs + * as keys. A key maps to a {@link PropertyIDMap} describing the + * property IDs in sections with the specified section format ID.

+ * + * @author Rainer Klute (klute@rainer-klute.de) + */ +public class SectionIDMap { + + /** + *

The SummaryInformation's section's format ID.

+ */ + public static final byte[] SUMMARY_INFORMATION_ID = new byte[] + { + (byte) 0xF2, (byte) 0x9F, (byte) 0x85, (byte) 0xE0, + (byte) 0x4F, (byte) 0xF9, (byte) 0x10, (byte) 0x68, + (byte) 0xAB, (byte) 0x91, (byte) 0x08, (byte) 0x00, + (byte) 0x2B, (byte) 0x27, (byte) 0xB3, (byte) 0xD9 + }; + + /** + *

The DocumentSummaryInformation's first and second sections' format + * ID.

+ */ + public static final byte[][] DOCUMENT_SUMMARY_INFORMATION_ID = new byte[][] + { + { + (byte) 0xD5, (byte) 0xCD, (byte) 0xD5, (byte) 0x02, + (byte) 0x2E, (byte) 0x9C, (byte) 0x10, (byte) 0x1B, + (byte) 0x93, (byte) 0x97, (byte) 0x08, (byte) 0x00, + (byte) 0x2B, (byte) 0x2C, (byte) 0xF9, (byte) 0xAE + }, + { + (byte) 0xD5, (byte) 0xCD, (byte) 0xD5, (byte) 0x05, + (byte) 0x2E, (byte) 0x9C, (byte) 0x10, (byte) 0x1B, + (byte) 0x93, (byte) 0x97, (byte) 0x08, (byte) 0x00, + (byte) 0x2B, (byte) 0x2C, (byte) 0xF9, (byte) 0xAE + } + }; +} Index: /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/wellknown/package.html =================================================================== --- /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/wellknown/package.html (revision 28000) +++ /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hpsf/wellknown/package.html (revision 28000) @@ -0,0 +1,59 @@ + + + + + + + + +

+ Specific support for DocumentSummaryInformation, SummaryInformation types. +

Support classes for "well-known" section format IDs and property IDs. The + streams \005DocumentSummaryInformation and + \005SummaryInformation (or any streams with the same section + format IDs as the aforementioned) are considered well-known. So are most + property IDs in these streams.

+ +

+ @author Rainer Klute (klute@rainer-klute.de) +

+ + + + + Index: /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hssf/OldExcelFormatException.java =================================================================== --- /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hssf/OldExcelFormatException.java (revision 28000) +++ /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hssf/OldExcelFormatException.java (revision 28000) @@ -0,0 +1,26 @@ +/* ==================================================================== + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +==================================================================== */ +package org.apache.poi.hssf; + +import org.apache.poi.OldFileFormatException; + +@SuppressWarnings("serial") +public class OldExcelFormatException extends OldFileFormatException { + public OldExcelFormatException(String s) { + super(s); + } +} Index: /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hssf/model/HSSFFormulaParser.java =================================================================== --- /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hssf/model/HSSFFormulaParser.java (revision 28000) +++ /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hssf/model/HSSFFormulaParser.java (revision 28000) @@ -0,0 +1,46 @@ +/* ==================================================================== + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +==================================================================== */ + +package org.apache.poi.hssf.model; + +import org.apache.poi.hssf.record.formula.Ptg; +import org.apache.poi.hssf.usermodel.HSSFEvaluationWorkbook; +import org.apache.poi.hssf.usermodel.HSSFWorkbook; +import org.apache.poi.ss.formula.FormulaRenderer; + +/** + * HSSF wrapper for the {@link FormulaParser} and {@link FormulaRenderer} + * + * @author Josh Micich + */ +public final class HSSFFormulaParser { + + private HSSFFormulaParser() { + // no instances of this class + } + + /** + * Static method to convert an array of {@link Ptg}s in RPN order + * to a human readable string format in infix mode. + * @param book used for defined names and 3D references + * @param ptgs must not be null + * @return a human readable String + */ + public static String toFormulaString(HSSFWorkbook book, Ptg[] ptgs) { + return FormulaRenderer.toFormulaString(HSSFEvaluationWorkbook.create(book), ptgs); + } +} Index: /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hssf/model/InternalSheet.java =================================================================== --- /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hssf/model/InternalSheet.java (revision 28000) +++ /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hssf/model/InternalSheet.java (revision 28000) @@ -0,0 +1,618 @@ +/* ==================================================================== + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +==================================================================== */ + +package org.apache.poi.hssf.model; + +import java.util.ArrayList; +import java.util.Iterator; +import java.util.List; + +import org.apache.poi.hssf.record.BOFRecord; +import org.apache.poi.hssf.record.CalcCountRecord; +import org.apache.poi.hssf.record.CalcModeRecord; +import org.apache.poi.hssf.record.CellValueRecordInterface; +import org.apache.poi.hssf.record.ColumnInfoRecord; +import org.apache.poi.hssf.record.DVALRecord; +import org.apache.poi.hssf.record.DeltaRecord; +import org.apache.poi.hssf.record.DimensionsRecord; +import org.apache.poi.hssf.record.EOFRecord; +import org.apache.poi.hssf.record.FeatHdrRecord; +import org.apache.poi.hssf.record.FeatRecord; +import org.apache.poi.hssf.record.GridsetRecord; +import org.apache.poi.hssf.record.GutsRecord; +import org.apache.poi.hssf.record.IndexRecord; +import org.apache.poi.hssf.record.IterationRecord; +import org.apache.poi.hssf.record.MergeCellsRecord; +import org.apache.poi.hssf.record.Record; +import org.apache.poi.hssf.record.RecordBase; +import org.apache.poi.hssf.record.RefModeRecord; +import org.apache.poi.hssf.record.RowRecord; +import org.apache.poi.hssf.record.SaveRecalcRecord; +import org.apache.poi.hssf.record.SelectionRecord; +import org.apache.poi.hssf.record.UncalcedRecord; +import org.apache.poi.hssf.record.WSBoolRecord; +import org.apache.poi.hssf.record.WindowTwoRecord; +import org.apache.poi.hssf.record.aggregates.ColumnInfoRecordsAggregate; +import org.apache.poi.hssf.record.aggregates.DataValidityTable; +import org.apache.poi.hssf.record.aggregates.MergedCellsTable; +import org.apache.poi.hssf.record.aggregates.RowRecordsAggregate; +import org.apache.poi.util.Internal; +import org.apache.poi.util.POILogFactory; +import org.apache.poi.util.POILogger; + +/** + * Low level model implementation of a Sheet (one workbook contains many sheets) + * This file contains the low level binary records starting at the sheets BOF and + * ending with the sheets EOF. Use HSSFSheet for a high level representation. + *

+ * @author Andrew C. Oliver (acoliver at apache dot org) + * @author Glen Stampoultzis (glens at apache.org) + * @author Shawn Laubach (slaubach at apache dot org) Gridlines, Headers, Footers, PrintSetup, and Setting Default Column Styles + * @author Jason Height (jheight at chariot dot net dot au) Clone support. DBCell & Index Record writing support + * @author Brian Sanders (kestrel at burdell dot org) Active Cell support + * @author Jean-Pierre Paris (jean-pierre.paris at m4x dot org) (Just a little) + * + * @see org.apache.poi.hssf.model.InternalWorkbook + * @see org.apache.poi.hssf.usermodel.HSSFSheet + */ +@Internal +public final class InternalSheet { + + private static POILogger log = POILogFactory.getLogger(InternalSheet.class); + + private List _records; + protected GridsetRecord gridset = null; + private GutsRecord _gutsRecord; + protected WindowTwoRecord windowTwo = null; + protected SelectionRecord _selection = null; + /** java object always present, but if empty no BIFF records are written */ + private final MergedCellsTable _mergedCellsTable; + /** always present in this POI object, not always written to Excel file */ + /*package*/ColumnInfoRecordsAggregate _columnInfos; + /** the DimensionsRecord is always present */ + private DimensionsRecord _dimensions; + /** always present */ + protected final RowRecordsAggregate _rowsAggregate; + private DataValidityTable _dataValidityTable= null; + private Iterator rowRecIterator = null; + + /** + * read support (offset used as starting point for search) for low level + * API. Pass in an array of Record objects, the sheet number (0 based) and + * a record offset (should be the location of the sheets BOF record). A Sheet + * object is constructed and passed back with all of its initialization set + * to the passed in records and references to those records held. This function + * is normally called via Workbook. + * + * @param rs the stream to read records from + * + * @return Sheet object with all values set to those read from the file + * + * @see org.apache.poi.hssf.model.InternalWorkbook + * @see org.apache.poi.hssf.record.Record + */ + public static InternalSheet createSheet(RecordStream rs) { + return new InternalSheet(rs); + } + private InternalSheet(RecordStream rs) { + _mergedCellsTable = new MergedCellsTable(); + RowRecordsAggregate rra = null; + + List records = new ArrayList(128); + _records = records; // needed here due to calls to findFirstRecordLocBySid before we're done + int dimsloc = -1; + + if (rs.peekNextSid() != BOFRecord.sid) { + throw new RuntimeException("BOF record expected"); + } + BOFRecord bof = (BOFRecord) rs.getNext(); + if (bof.getType() != BOFRecord.TYPE_WORKSHEET) { + // TODO - fix junit tests throw new RuntimeException("Bad BOF record type"); + } + records.add(bof); + while (rs.hasNext()) { + int recSid = rs.peekNextSid(); + + if (recSid == ColumnInfoRecord.sid) { + _columnInfos = new ColumnInfoRecordsAggregate(rs); + records.add(_columnInfos); + continue; + } + if ( recSid == DVALRecord.sid) { + _dataValidityTable = new DataValidityTable(rs); + records.add(_dataValidityTable); + continue; + } + + if (RecordOrderer.isRowBlockRecord(recSid)) { + //only add the aggregate once + if (rra != null) { + throw new RuntimeException("row/cell records found in the wrong place"); + } + RowBlocksReader rbr = new RowBlocksReader(rs); + _mergedCellsTable.addRecords(rbr.getLooseMergedCells()); + rra = new RowRecordsAggregate(rbr.getPlainRecordStream(), rbr.getSharedFormulaManager()); + records.add(rra); //only add the aggregate once + continue; + } + + if (recSid == MergeCellsRecord.sid) { + // when the MergedCellsTable is found in the right place, we expect those records to be contiguous + _mergedCellsTable.read(rs); + continue; + } + + if (recSid == BOFRecord.sid) { + continue; + } + + Record rec = rs.getNext(); + if ( recSid == IndexRecord.sid ) { + // ignore INDEX record because it is only needed by Excel, + // and POI always re-calculates its contents + continue; + } + + + if (recSid == UncalcedRecord.sid) { + // don't add UncalcedRecord to the list + continue; + } + + if (recSid == FeatRecord.sid || + recSid == FeatHdrRecord.sid) { + records.add(rec); + continue; + } + + if (recSid == EOFRecord.sid) { + records.add(rec); + break; + } + + if (recSid == DimensionsRecord.sid) + { + // Make a columns aggregate if one hasn't ready been created. + if (_columnInfos == null) + { + _columnInfos = new ColumnInfoRecordsAggregate(); + records.add(_columnInfos); + } + + _dimensions = ( DimensionsRecord ) rec; + dimsloc = records.size(); + } + else if ( recSid == GridsetRecord.sid ) + { + gridset = (GridsetRecord) rec; + } + else if ( recSid == SelectionRecord.sid ) + { + _selection = (SelectionRecord) rec; + } + else if ( recSid == WindowTwoRecord.sid ) + { + windowTwo = (WindowTwoRecord) rec; + } + else if ( recSid == GutsRecord.sid ) + { + _gutsRecord = (GutsRecord) rec; + } + + records.add(rec); + } + if (windowTwo == null) { + throw new RuntimeException("WINDOW2 was not found"); + } + if (_dimensions == null) { + // Excel seems to always write the DIMENSION record, but tolerates when it is not present + // in all cases Excel (2007) adds the missing DIMENSION record + if (rra == null) { + // bug 46206 alludes to files which skip the DIMENSION record + // when there are no row/cell records. + // Not clear which application wrote these files. + rra = new RowRecordsAggregate(); + } else { + log.log(POILogger.WARN, "DIMENSION record not found even though row/cells present"); + // Not sure if any tools write files like this, but Excel reads them OK + } + dimsloc = findFirstRecordLocBySid(WindowTwoRecord.sid); + _dimensions = rra.createDimensions(); + records.add(dimsloc, _dimensions); + } + if (rra == null) { + rra = new RowRecordsAggregate(); + records.add(dimsloc + 1, rra); + } + _rowsAggregate = rra; + // put merged cells table in the right place (regardless of where the first MergedCellsRecord was found */ + RecordOrderer.addNewSheetRecord(records, _mergedCellsTable); + if (log.check( POILogger.DEBUG )) + log.log(POILogger.DEBUG, "sheet createSheet (existing file) exited"); + } + + private InternalSheet() { + _mergedCellsTable = new MergedCellsTable(); + List records = new ArrayList(32); + + if (log.check( POILogger.DEBUG )) + log.log(POILogger.DEBUG, "Sheet createsheet from scratch called"); + + records.add(createBOF()); + + records.add(createCalcMode()); + records.add(createCalcCount() ); + records.add(createRefMode() ); + records.add(createIteration() ); + records.add(createDelta() ); + records.add(createSaveRecalc() ); + gridset = createGridset(); + records.add( gridset ); + _gutsRecord = createGuts(); + records.add( _gutsRecord ); + records.add( createWSBool() ); + + ColumnInfoRecordsAggregate columns = new ColumnInfoRecordsAggregate(); + records.add( columns ); + _columnInfos = columns; + _dimensions = createDimensions(); + records.add(_dimensions); + _rowsAggregate = new RowRecordsAggregate(); + records.add(_rowsAggregate); + // 'Sheet View Settings' + records.add(windowTwo = createWindowTwo()); + _selection = createSelection(); + records.add(_selection); + + records.add(_mergedCellsTable); // MCT comes after 'Sheet View Settings' + records.add(EOFRecord.instance); + + _records = records; + if (log.check( POILogger.DEBUG )) + log.log(POILogger.DEBUG, "Sheet createsheet from scratch exit"); + } + + public RowRecordsAggregate getRowsAggregate() { + return _rowsAggregate; + } + + /** + * Adds a value record to the sheet's contained binary records + * (i.e. LabelSSTRecord or NumberRecord). + *

+ * This method is "loc" sensitive. Meaning you need to set LOC to where you + * want it to start searching. If you don't know do this: setLoc(getDimsLoc). + * When adding several rows you can just start at the last one by leaving loc + * at what this sets it to. + * + * @param row the row to add the cell value to + * @param col the cell value record itself. + */ + public void addValueRecord(int row, CellValueRecordInterface col) { + + if(log.check(POILogger.DEBUG)) { + log.log(POILogger.DEBUG, "add value record row" + row); + } + DimensionsRecord d = _dimensions; + + if (col.getColumn() > d.getLastCol()) { + d.setLastCol(( short ) (col.getColumn() + 1)); + } + if (col.getColumn() < d.getFirstCol()) { + d.setFirstCol(col.getColumn()); + } + _rowsAggregate.insertCell(col); + } + + /** + * replace a value record from the records array. + * + * This method is not loc sensitive, it resets loc to = dimsloc so no worries. + * + * @param newval - a record supporting the CellValueRecordInterface. this will replace + * the cell value with the same row and column. If there isn't one, one will + * be added. + */ + + public void replaceValueRecord(CellValueRecordInterface newval) { + + if (log.check( POILogger.DEBUG )) + log.log(POILogger.DEBUG, "replaceValueRecord "); + //The ValueRecordsAggregate use a tree map underneath. + //The tree Map uses the CellValueRecordInterface as both the + //key and the value, if we dont do a remove, then + //the previous instance of the key is retained, effectively using + //double the memory + _rowsAggregate.removeCell(newval); + _rowsAggregate.insertCell(newval); + } + + /** + * Adds a row record to the sheet + * + *

+ * This method is "loc" sensitive. Meaning you need to set LOC to where you + * want it to start searching. If you don't know do this: setLoc(getDimsLoc). + * When adding several rows you can just start at the last one by leaving loc + * at what this sets it to. + * + * @param row the row record to be added + */ + + public void addRow(RowRecord row) { + if (log.check( POILogger.DEBUG )) + log.log(POILogger.DEBUG, "addRow "); + DimensionsRecord d = _dimensions; + + if (row.getRowNumber() >= d.getLastRow()) { + d.setLastRow(row.getRowNumber() + 1); + } + if (row.getRowNumber() < d.getFirstRow()) { + d.setFirstRow(row.getRowNumber()); + } + + //If the row exists remove it, so that any cells attached to the row are removed + RowRecord existingRow = _rowsAggregate.getRow(row.getRowNumber()); + if (existingRow != null) { + _rowsAggregate.removeRow(existingRow); + } + + _rowsAggregate.insertRow(row); + + if (log.check( POILogger.DEBUG )) + log.log(POILogger.DEBUG, "exit addRow"); + } + + + /** + * get the NEXT value record (from LOC). The first record that is a value record + * (starting at LOC) will be returned. + * + *

+ * This method is "loc" sensitive. Meaning you need to set LOC to where you + * want it to start searching. If you don't know do this: setLoc(getDimsLoc). + * When adding several rows you can just start at the last one by leaving loc + * at what this sets it to. For this method, set loc to dimsloc to start with. + * subsequent calls will return rows in (physical) sequence or NULL when you get to the end. + * + * @return RowRecord representing the next row record or NULL if there are no more + */ + public RowRecord getNextRow() { + if (rowRecIterator == null) + { + rowRecIterator = _rowsAggregate.getIterator(); + } + if (!rowRecIterator.hasNext()) + { + return null; + } + return rowRecIterator.next(); + } + + + /** + * creates the BOF record + */ + /* package */ static BOFRecord createBOF() { + BOFRecord retval = new BOFRecord(); + + retval.setVersion(( short ) 0x600); + retval.setType(( short ) 0x010); + + retval.setBuild(( short ) 0x0dbb); + retval.setBuildYear(( short ) 1996); + retval.setHistoryBitMask(0xc1); + retval.setRequiredVersion(0x6); + return retval; + } + + /** + * creates the CalcMode record and sets it to 1 (automatic formula caculation) + */ + private static CalcModeRecord createCalcMode() { + CalcModeRecord retval = new CalcModeRecord(); + + retval.setCalcMode(( short ) 1); + return retval; + } + + /** + * creates the CalcCount record and sets it to 100 (default number of iterations) + */ + private static CalcCountRecord createCalcCount() { + CalcCountRecord retval = new CalcCountRecord(); + + retval.setIterations(( short ) 100); // default 100 iterations + return retval; + } + + /** + * creates the RefMode record and sets it to A1 Mode (default reference mode) + */ + private static RefModeRecord createRefMode() { + RefModeRecord retval = new RefModeRecord(); + + retval.setMode(RefModeRecord.USE_A1_MODE); + return retval; + } + + /** + * creates the Iteration record and sets it to false (don't iteratively calculate formulas) + */ + private static IterationRecord createIteration() { + return new IterationRecord(false); + } + + /** + * creates the Delta record and sets it to 0.0010 (default accuracy) + */ + private static DeltaRecord createDelta() { + return new DeltaRecord(DeltaRecord.DEFAULT_VALUE); + } + + /** + * creates the SaveRecalc record and sets it to true (recalculate before saving) + */ + private static SaveRecalcRecord createSaveRecalc() { + SaveRecalcRecord retval = new SaveRecalcRecord(); + + retval.setRecalc(true); + return retval; + } + + /** + * creates the Gridset record and sets it to true (user has mucked with the gridlines) + */ + private static GridsetRecord createGridset() { + GridsetRecord retval = new GridsetRecord(); + + retval.setGridset(true); + return retval; + } + + /** + * creates the Guts record and sets leftrow/topcol guttter and rowlevelmax/collevelmax to 0 + */ + private static GutsRecord createGuts() { + GutsRecord retval = new GutsRecord(); + + retval.setLeftRowGutter(( short ) 0); + retval.setTopColGutter(( short ) 0); + retval.setRowLevelMax(( short ) 0); + retval.setColLevelMax(( short ) 0); + return retval; + } + + /** + * creates the WSBoolRecord and sets its values to defaults + */ + private static WSBoolRecord createWSBool() { + WSBoolRecord retval = new WSBoolRecord(); + + retval.setWSBool1(( byte ) 0x4); + retval.setWSBool2(( byte ) 0xffffffc1); + return retval; + } + + /** + * get the index to the ExtendedFormatRecord "associated" with + * the column at specified 0-based index. (In this case, an + * ExtendedFormatRecord index is actually associated with a + * ColumnInfoRecord which spans 1 or more columns) + *
+ * Returns the index to the default ExtendedFormatRecord (0xF) + * if no ColumnInfoRecord exists that includes the column + * index specified. + * @param columnIndex + * @return index of ExtendedFormatRecord associated with + * ColumnInfoRecord that includes the column index or the + * index of the default ExtendedFormatRecord (0xF) + */ + public short getXFIndexForColAt(short columnIndex) { + ColumnInfoRecord ci = _columnInfos.findColumnInfo(columnIndex); + if (ci != null) { + return (short)ci.getXFIndex(); + } + return 0xF; + } + + /** + * creates the Dimensions Record and sets it to bogus values (you should set this yourself + * or let the high level API do it for you) + */ + private static DimensionsRecord createDimensions() { + DimensionsRecord retval = new DimensionsRecord(); + + retval.setFirstCol(( short ) 0); + retval.setLastRow(1); // one more than it is + retval.setFirstRow(0); + retval.setLastCol(( short ) 1); // one more than it is + return retval; + } + + /** + * creates the WindowTwo Record and sets it to:

+ * options = 0x6b6

+ * toprow = 0

+ * leftcol = 0

+ * headercolor = 0x40

+ * pagebreakzoom = 0x0

+ * normalzoom = 0x0

+ */ + private static WindowTwoRecord createWindowTwo() { + WindowTwoRecord retval = new WindowTwoRecord(); + + retval.setOptions(( short ) 0x6b6); + retval.setTopRow(( short ) 0); + retval.setLeftCol(( short ) 0); + retval.setHeaderColor(0x40); + retval.setPageBreakZoom(( short ) 0); + retval.setNormalZoom(( short ) 0); + return retval; + } + + /** + * Creates the Selection record and sets it to nothing selected + */ + private static SelectionRecord createSelection() { + return new SelectionRecord(0, 0); + } + + /** + * Finds the first occurrence of a record matching a particular sid and + * returns it's position. + * @param sid the sid to search for + * @return the record position of the matching record or -1 if no match + * is made. + */ + public int findFirstRecordLocBySid( short sid ) { // TODO - remove this method + int max = _records.size(); + for (int i=0; i< max; i++) { + Object rb = _records.get(i); + if (!(rb instanceof Record)) { + continue; + } + Record record = (Record) rb; + if (record.getSid() == sid) { + return i; + } + } + return -1; + } +} Index: /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hssf/model/InternalWorkbook.java =================================================================== --- /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hssf/model/InternalWorkbook.java (revision 28000) +++ /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hssf/model/InternalWorkbook.java (revision 28000) @@ -0,0 +1,467 @@ +/* ==================================================================== + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +==================================================================== */ + +package org.apache.poi.hssf.model; + +import java.util.ArrayList; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; + +import org.apache.poi.hssf.record.BoundSheetRecord; +import org.apache.poi.hssf.record.DateWindow1904Record; +import org.apache.poi.hssf.record.EOFRecord; +import org.apache.poi.hssf.record.ExtSSTRecord; +import org.apache.poi.hssf.record.ExtendedFormatRecord; +import org.apache.poi.hssf.record.ExternSheetRecord; +import org.apache.poi.hssf.record.FormatRecord; +import org.apache.poi.hssf.record.HyperlinkRecord; +import org.apache.poi.hssf.record.NameCommentRecord; +import org.apache.poi.hssf.record.NameRecord; +import org.apache.poi.hssf.record.Record; +import org.apache.poi.hssf.record.SSTRecord; +import org.apache.poi.hssf.record.SupBookRecord; +import org.apache.poi.hssf.record.TabIdRecord; +import org.apache.poi.hssf.record.WindowOneRecord; +import org.apache.poi.hssf.record.common.UnicodeString; +import org.apache.poi.ss.formula.EvaluationWorkbook.ExternalSheet; +import org.apache.poi.util.Internal; +import org.apache.poi.util.POILogFactory; +import org.apache.poi.util.POILogger; + +/** + * Low level model implementation of a Workbook. Provides creational methods + * for settings and objects contained in the workbook object. + *

+ * This file contains the low level binary records starting at the workbook's BOF and + * ending with the workbook's EOF. Use HSSFWorkbook for a high level representation. + *

+ * The structures of the highlevel API use references to this to perform most of their + * operations. Its probably unwise to use these low level structures directly unless you + * really know what you're doing. I recommend you read the Microsoft Excel 97 Developer's + * Kit (Microsoft Press) and the documentation at http://sc.openoffice.org/excelfileformat.pdf + * before even attempting to use this. + * + * + * @author Luc Girardin (luc dot girardin at macrofocus dot com) + * @author Sergei Kozello (sergeikozello at mail.ru) + * @author Shawn Laubach (slaubach at apache dot org) (Data Formats) + * @author Andrew C. Oliver (acoliver at apache dot org) + * @author Brian Sanders (bsanders at risklabs dot com) - custom palette + * @author Dan Sherman (dsherman at isisph.com) + * @author Glen Stampoultzis (glens at apache.org) + * @see org.apache.poi.hssf.usermodel.HSSFWorkbook + */ +@Internal +public final class InternalWorkbook { + + + private static final POILogger log = POILogFactory.getLogger(InternalWorkbook.class); + private static final int DEBUG = POILogger.DEBUG; + + /** + * this contains the Worksheet record objects + */ + private final WorkbookRecordList records; + + /** + * this contains a reference to the SSTRecord so that new stings can be added + * to it. + */ + protected SSTRecord sst; + + + private LinkTable linkTable; // optionally occurs if there are references in the document. (4.10.3) + + /** + * holds the "boundsheet" records (aka bundlesheet) so that they can have their + * reference to their "BOF" marker + */ + private final List boundsheets; + private final List formats; + private final List hyperlinks; + + /** the number of extended format records */ + private int numxfs; + /** holds the max format id */ + private int maxformatid; + /** whether 1904 date windowing is being used */ + private boolean uses1904datewindowing; + private WindowOneRecord windowOne; + + /** + * Hold the {@link NameCommentRecord}s indexed by the name of the {@link NameRecord} to which they apply. + */ + private final Map commentRecords; + + private InternalWorkbook() { + records = new WorkbookRecordList(); + + boundsheets = new ArrayList(); + formats = new ArrayList(); + hyperlinks = new ArrayList(); + numxfs = 0; + maxformatid = -1; + uses1904datewindowing = false; + commentRecords = new LinkedHashMap(); + } + + /** + * read support for low level + * API. Pass in an array of Record objects, A Workbook + * object is constructed and passed back with all of its initialization set + * to the passed in records and references to those records held. Unlike Sheet + * workbook does not use an offset (its assumed to be 0) since its first in a file. + * If you need an offset then construct a new array with a 0 offset or write your + * own ;-p. + * + * @param recs an array of Record objects + * @return Workbook object + */ + public static InternalWorkbook createWorkbook(List recs) { + if (log.check( POILogger.DEBUG )) + log.log(DEBUG, "Workbook (readfile) created with reclen=", + Integer.valueOf(recs.size())); + InternalWorkbook retval = new InternalWorkbook(); + List records = new ArrayList(recs.size() / 3); + retval.records.setRecords(records); + + int k; + for (k = 0; k < recs.size(); k++) { + Record rec = recs.get(k); + + if (rec.getSid() == EOFRecord.sid) { + records.add(rec); + if (log.check( POILogger.DEBUG )) + log.log(DEBUG, "found workbook eof record at " + k); + break; + } + switch (rec.getSid()) { + + case BoundSheetRecord.sid : + if (log.check( POILogger.DEBUG )) + log.log(DEBUG, "found boundsheet record at " + k); + retval.boundsheets.add((BoundSheetRecord) rec); + retval.records.setBspos( k ); + break; + + case SSTRecord.sid : + if (log.check( POILogger.DEBUG )) + log.log(DEBUG, "found sst record at " + k); + retval.sst = ( SSTRecord ) rec; + break; + + case ExtendedFormatRecord.sid : + if (log.check( POILogger.DEBUG )) + log.log(DEBUG, "found XF record at " + k); + retval.records.setXfpos( k ); + retval.numxfs++; + break; + + case TabIdRecord.sid : + if (log.check( POILogger.DEBUG )) + log.log(DEBUG, "found tabid record at " + k); + retval.records.setTabpos( k ); + break; + + case ExternSheetRecord.sid : + throw new RuntimeException("Extern sheet is part of LinkTable"); + case NameRecord.sid : + case SupBookRecord.sid : + // LinkTable can start with either of these + if (log.check( POILogger.DEBUG )) + log.log(DEBUG, "found SupBook record at " + k); + retval.linkTable = new LinkTable(recs, k, retval.records, retval.commentRecords); + k+=retval.linkTable.getRecordCount() - 1; + continue; + case FormatRecord.sid : + if (log.check( POILogger.DEBUG )) + log.log(DEBUG, "found format record at " + k); + retval.formats.add((FormatRecord) rec); + retval.maxformatid = retval.maxformatid >= ((FormatRecord)rec).getIndexCode() ? retval.maxformatid : ((FormatRecord)rec).getIndexCode(); + break; + case DateWindow1904Record.sid : + if (log.check( POILogger.DEBUG )) + log.log(DEBUG, "found datewindow1904 record at " + k); + retval.uses1904datewindowing = ((DateWindow1904Record)rec).getWindowing() == 1; + break; + case WindowOneRecord.sid: + if (log.check( POILogger.DEBUG )) + log.log(DEBUG, "found WindowOneRecord at " + k); + retval.windowOne = (WindowOneRecord) rec; + break; + case NameCommentRecord.sid: + final NameCommentRecord ncr = (NameCommentRecord) rec; + if (log.check( POILogger.DEBUG )) + log.log(DEBUG, "found NameComment at " + k); + retval.commentRecords.put(ncr.getNameText(), ncr); + default : + } + records.add(rec); + } + //What if we dont have any ranges and supbooks + // if (retval.records.supbookpos == 0) { + // retval.records.supbookpos = retval.records.bspos + 1; + // retval.records.namepos = retval.records.supbookpos + 1; + // } + + // Look for other interesting values that + // follow the EOFRecord + for ( ; k < recs.size(); k++) { + Record rec = recs.get(k); + switch (rec.getSid()) { + case HyperlinkRecord.sid: + retval.hyperlinks.add((HyperlinkRecord)rec); + break; + } + } + + if (retval.windowOne == null) { + retval.windowOne = createWindowOne(); + } + if (log.check( POILogger.DEBUG )) + log.log(DEBUG, "exit create workbook from existing file function"); + return retval; + } + + public int getNumRecords() { + return records.size(); + } + + + private BoundSheetRecord getBoundSheetRec(int sheetIndex) { + return boundsheets.get(sheetIndex); + } + + + /** + * gets the name for a given sheet. + * + * @param sheetIndex the sheet number (0 based) + * @return sheetname the name for the sheet + */ + public String getSheetName(int sheetIndex) { + return getBoundSheetRec(sheetIndex).getSheetname(); + } + + /** + * gets the ExtendedFormatRecord at the given 0-based index + * + * @param index of the Extended format record (0-based) + * @return ExtendedFormatRecord at the given index + */ + + public ExtendedFormatRecord getExFormatAt(int index) { + int xfptr = records.getXfpos() - (numxfs - 1); + + xfptr += index; + ExtendedFormatRecord retval = + ( ExtendedFormatRecord ) records.get(xfptr); + + return retval; + } + + /** + * Adds a string to the SST table and returns its index (if its a duplicate + * just returns its index and update the counts) ASSUMES compressed unicode + * (meaning 8bit) + * + * @param string the string to be added to the SSTRecord + * + * @return index of the string within the SSTRecord + */ + + public int addSSTString(UnicodeString string) { + if (log.check( POILogger.DEBUG )) + log.log(DEBUG, "insert to sst string='", string); + if (sst == null) { + insertSST(); + } + return sst.addString(string); + } + + /** + * given an index into the SST table, this function returns the corresponding String value + * @return String containing the SST String + */ + + public UnicodeString getSSTString(int str) { + if (sst == null) { + insertSST(); + } + UnicodeString retval = sst.getString(str); + + if (log.check( POILogger.DEBUG )) + log.log(DEBUG, "Returning SST for index=", Integer.valueOf(str), + " String= ", retval); + return retval; + } + + /** + * use this function to add a Shared String Table to an existing sheet (say + * generated by a different java api) without an sst.... + * @see #createExtendedSST() + * @see org.apache.poi.hssf.record.SSTRecord + */ + + public void insertSST() { + if (log.check( POILogger.DEBUG )) + log.log(DEBUG, "creating new SST via insertSST!"); + sst = new SSTRecord(); + records.add(records.size() - 1, createExtendedSST()); + records.add(records.size() - 2, sst); + } + + /** + * Serializes all records int the worksheet section into a big byte array. Use + * this to write the Workbook out. + * + * @return byte array containing the HSSF-only portions of the POIFS file. + */ + // GJS: Not used so why keep it. +// public byte [] serialize() { +// log.log(DEBUG, "Serializing Workbook!"); +// byte[] retval = null; +// +//// ArrayList bytes = new ArrayList(records.size()); +// int arraysize = getSize(); +// int pos = 0; +// +// retval = new byte[ arraysize ]; +// for (int k = 0; k < records.size(); k++) { +// +// Record record = records.get(k); +//// Let's skip RECALCID records, as they are only use for optimization +// if(record.getSid() != RecalcIdRecord.sid || ((RecalcIdRecord)record).isNeeded()) { +// pos += record.serialize(pos, retval); // rec.length; +// } +// } +// log.log(DEBUG, "Exiting serialize workbook"); +// return retval; +// } + + /** + * creates the WindowOne record with the following magic values:

+ * horizontal hold - 0x168

+ * vertical hold - 0x10e

+ * width - 0x3a5c

+ * height - 0x23be

+ * options - 0x38

+ * selected tab - 0

+ * displayed tab - 0

+ * num selected tab- 0

+ * tab width ratio - 0x258

+ */ + private static WindowOneRecord createWindowOne() { + WindowOneRecord retval = new WindowOneRecord(); + + retval.setHorizontalHold(( short ) 0x168); + retval.setVerticalHold(( short ) 0x10e); + retval.setWidth(( short ) 0x3a5c); + retval.setHeight(( short ) 0x23be); + retval.setOptions(( short ) 0x38); + retval.setActiveSheetIndex( 0x0); + retval.setFirstVisibleTab(0x0); + retval.setNumSelectedTabs(( short ) 1); + retval.setTabWidthRatio(( short ) 0x258); + return retval; + } + + /** + * Creates the ExtendedSST record with numstrings per bucket set to 0x8. HSSF + * doesn't yet know what to do with this thing, but we create it with nothing in + * it hardly just to make Excel happy and our sheets look like Excel's + */ + private static ExtSSTRecord createExtendedSST() { + ExtSSTRecord retval = new ExtSSTRecord(); + retval.setNumStringsPerBucket(( short ) 0x8); + return retval; + } + + /** finds the sheet name by his extern sheet index + * @param externSheetIndex extern sheet index + * @return sheet name. + */ + public String findSheetNameFromExternSheet(int externSheetIndex){ + + int indexToSheet = linkTable.getIndexToInternalSheet(externSheetIndex); + if (indexToSheet < 0) { + // TODO - what does '-1' mean here? + //error check, bail out gracefully! + return ""; + } + if (indexToSheet >= boundsheets.size()) { + // Not sure if this can ever happen (See bug 45798) + return ""; // Seems to be what excel would do in this case + } + return getSheetName(indexToSheet); + } + public ExternalSheet getExternalSheet(int externSheetIndex) { + String[] extNames = linkTable.getExternalBookAndSheetName(externSheetIndex); + if (extNames == null) { + return null; + } + return new ExternalSheet(extNames[0], extNames[1]); + } + + /** gets the total number of names + * @return number of names + */ + public int getNumNames(){ + if(linkTable == null) { + return 0; + } + return linkTable.getNumNames(); + } + + /** gets the name record + * @param index name index + * @return name record + */ + public NameRecord getNameRecord(int index){ + return linkTable.getNameRecord(index); + } + + + + /** + * Returns the list of FormatRecords in the workbook. + * @return ArrayList of FormatRecords in the notebook + */ + public List getFormats() { + return formats; + } + + /** + * Whether date windowing is based on 1/2/1904 or 1/1/1900. + * Some versions of Excel (Mac) can save workbooks using 1904 date windowing. + * + * @return true if using 1904 date windowing + */ + public boolean isUsing1904DateWindowing() { + return uses1904datewindowing; + } + + /** + * @param refIndex Index to REF entry in EXTERNSHEET record in the Link Table + * @param definedNameIndex zero-based to DEFINEDNAME or EXTERNALNAME record + * @return the string representation of the defined or external name + */ + public String resolveNameXText(int refIndex, int definedNameIndex) { + return linkTable.resolveNameXText(refIndex, definedNameIndex); + } +} Index: /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hssf/model/LinkTable.java =================================================================== --- /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hssf/model/LinkTable.java (revision 28000) +++ /applications/editors/josm/plugins/opendata/includes/org/apache/poi/hssf/model/LinkTable.java (revision 28000) @@ -0,0 +1,242 @@ +/* ==================================================================== + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +==================================================================== */ + +package org.apache.poi.hssf.model; + +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +import org.apache.poi.hssf.record.CRNCountRecord; +import org.apache.poi.hssf.record.CRNRecord; +import org.apache.poi.hssf.record.ExternSheetRecord; +import org.apache.poi.hssf.record.ExternalNameRecord; +import org.apache.poi.hssf.record.NameCommentRecord; +import org.apache.poi.hssf.record.NameRecord; +import org.apache.poi.hssf.record.Record; +import org.apache.poi.hssf.record.SupBookRecord; +import org.apache.poi.hssf.record.formula.Area3DPtg; +import org.apache.poi.hssf.record.formula.Ref3DPtg; + +/** + * Link Table (OOO pdf reference: 4.10.3 )

+ * + * The main data of all types of references is stored in the Link Table inside the Workbook Globals + * Substream (4.2.5). The Link Table itself is optional and occurs only, if there are any + * references in the document. + *

+ * + * In BIFF8 the Link Table consists of + *

zero or more EXTERNALBOOK Blocks
+ * each consisting of + *
- exactly one EXTERNALBOOK (0x01AE) record
- zero or more EXTERNALNAME (0x0023) records
- zero or more CRN Blocks
  + * each consisting of + *
  - exactly one XCT (0x0059)record
  - zero or more CRN (0x005A) records (documentation says one or more)
  + *
+ *
zero or one EXTERNSHEET (0x0017) record
zero or more DEFINEDNAME (0x0018) records

+ * + * + * @author Josh Micich + */ +final class LinkTable { + + + // TODO make this class into a record aggregate + + private static final class CRNBlock { + + private final CRNCountRecord _countRecord; + + public CRNBlock(RecordStream rs) { + _countRecord = (CRNCountRecord) rs.getNext(); + int nCRNs = _countRecord.getNumberOfCRNs(); + CRNRecord[] crns = new CRNRecord[nCRNs]; + for (int i = 0; i < crns.length; i++) { + crns[i] = (CRNRecord) rs.getNext(); + } + } + } + + private static final class ExternalBookBlock { + private final SupBookRecord _externalBookRecord; + private final ExternalNameRecord[] _externalNameRecords; + private final CRNBlock[] _crnBlocks; + + public ExternalBookBlock(RecordStream rs) { + _externalBookRecord = (SupBookRecord) rs.getNext(); + List

Number of `Point`s in argument `Geometry`	`Geometry` class of result
0	empty `GeometryCollection`
1	`Point`
2	`LineString`
3 or more	`Polygon`

Interface	Description
+ {@link org.apache.commons.collections.Bag} +	+ A new `Collection` subinterface that stores each object together + with the number of occurances. Methods are provided to get the number of + occurances, and to add and remove a certain number of that object. +
+ {@link org.apache.commons.collections.Buffer} +	+ A new `Collection` subinterface that allows objects to be removed + in some well-defined order. Methods enable the next item to be peeked and removed. +
+ {@link org.apache.commons.collections.BidiMap} +	+ A new `Map` subinterface that allows lookup from key to value and + from value to key with equal ease. +
+ {@link org.apache.commons.collections.OrderedMap} +	+ A new `Map` subinterface that is used when a map has an order, but is + not sorted. Methods enable bidriectional iteration through the map. +
+ {@link org.apache.commons.collections.MapIterator} +	+ A new `Iterator` subinterface specially designed for maps. This iterator + avoids the need for entrySet iteration of a map, and is simpler to use. +
+ {@link org.apache.commons.collections.ResettableIterator} +	+ A new `Iterator` subinterface that allows the iteration to be reset back + to the start. Many iterators in this library have this functionality. +
+ {@link org.apache.commons.collections.Closure} + {@link org.apache.commons.collections.Predicate} + {@link org.apache.commons.collections.Transformer} + {@link org.apache.commons.collections.Factory} +	+ A group of functor interfaces that provide plugin behaviour to various + collections and utilities. +

Bit number	Meaning if 0	Meaning if 1
0	string_data is byte[]	string_data is short[] + *
1	Should always be 0	string_flag is defective + *
2	extension is not included	extension is included + *
3	formatting run data is not included	formatting run data is included + *
4	Should always be 0	string_flag is defective + *
5	Should always be 0	string_flag is defective + *
6	Should always be 0	string_flag is defective + *
7	Should always be 0	string_flag is defective + *

Input	Result	Comments
"A1"	true
"a111"	true
"AA"	false
"aa1"	true
"A1A"	false
"A1A1"	false
"A$1:$C$20"	false	Not a plain cell reference
"SALES20080101"	true	Still needs delimiting even though well out of range

Result	Comment
A1:A1	Single cell area reference without sheet
A1:$C$1	Multi-cell area reference without sheet
Sheet1!A$1:B4	Standard sheet name
'O''Brien''s Sales'!B5:C6'	Sheet name with special characters

Version	File Format	Last Column	Last Row
97-2003	BIFF8	"IV" (2^8)	65536 (2^14)
2007	BIFF12	"XFD" (2^14)	1048576 (2^20)

Input	Result
"A", "1"	true
"a", "111"	true
"A", "65536"	true
"A", "65537"	false
"iv", "1"	true
"IW", "1"	false
"AAA", "1"	false
"a", "111"	true
"Sheet", "1"	false

Result	Comment
A1	Cell reference without sheet
Sheet1!A1	Standard sheet name
'O''Brien''s Sales'!A1'	Sheet name with special characters

Raw bits	Java	Excel
0x0000000000000000L	0.0	0
0x3FF0000000000000L	1.0	1
0x3FF00068DB8BAC71L	1.0001	1.0001
0x4087A00000000000L	756.0	756
0x401E3D70A3D70A3DL	7.56	7.56
0x405EDD3C07FB4C99L	123.45678901234568	123.456789012346
0x4132D687E3DF2180L	1234567.8901234567	1234567.89012346
0x3EE9E409302678BAL	1.2345678901234568E-5	1.23456789012346E-05
0x3F202E85BE180B74L	1.2345678901234567E-4	0.000123456789012346
0x3F543A272D9E0E51L	0.0012345678901234567	0.00123456789012346
0x3F8948B0F90591E6L	0.012345678901234568	0.0123456789012346
0x3EE9E409301B5A02L	1.23456789E-5	0.0000123456789
0x3E6E7D05BDABDE50L	5.6789012345E-8	0.000000056789012345
0x3E6E7D05BDAD407EL	5.67890123456E-8	5.67890123456E-08
0x3E6E7D06029F18BEL	5.678902E-8	0.00000005678902
0x2BCB5733CB32AE6EL	9.999999999999123E-98	9.99999999999912E-98
0x2B617F7D4ED8C59EL	1.0000000000001235E-99	1.0000000000001E-99
0x0036319916D67853L	1.2345678901234578E-307	1.2345678901235E-307
0x359DEE7A4AD4B81FL	2.0E-50	2E-50
0x41678C29DCD6E9E0L	1.2345678901234567E7	12345678.9012346
0x42A674E79C5FE523L	1.2345678901234568E13	12345678901234.6
0x42DC12218377DE6BL	1.2345678901234567E14	123456789012346
0x43118B54F22AEB03L	1.2345678901234568E15	1234567890123460
0x43E56A95319D63E1L	1.2345678901234567E19	12345678901234600000
0x441AC53A7E04BCDAL	1.2345678901234568E20	1.23456789012346E+20
0xC3E56A95319D63E1L	-1.2345678901234567E19	-12345678901234600000
0xC41AC53A7E04BCDAL	-1.2345678901234568E20	-1.23456789012346E+20
0x54820FE0BA17F46DL	1.2345678901234577E99	1.2345678901235E+99
0x54B693D8E89DF188L	1.2345678901234576E100	1.2345678901235E+100
0x4A611B0EC57E649AL	2.0E50	2E+50
0x7FEFFFFFFFFFFFFFL	1.7976931348623157E308	1.7976931348623E+308
0x0010000000000000L	2.2250738585072014E-308	2.2250738585072E-308
0x000FFFFFFFFFFFFFL	2.225073858507201E-308	0
0x0000000000000001L	4.9E-324	0
0x7FF0000000000000L	Infinity	1.7976931348623E+308
0xFFF0000000000000L	-Infinity	1.7976931348623E+308
0x441AC7A08EAD02F2L	1.234999999999999E20	1.235E+20
0x40FE26BFFFFFFFF9L	123499.9999999999	123500
0x3E4A857BFB2F2809L	1.234999999999999E-8	0.00000001235
0x3BCD291DEF868C89L	1.234999999999999E-20	1.235E-20
0x444B1AE4D6E2EF4FL	9.999999999999999E20	1E+21
0x412E847FFFFFFFFFL	999999.9999999999	1000000
0x3E45798EE2308C39L	9.999999999999999E-9	0.00000001
0x3C32725DD1D243ABL	9.999999999999999E-19	0.000000000000000001
0x3BFD83C94FB6D2ABL	9.999999999999999E-20	1E-19
0xC44B1AE4D6E2EF4FL	-9.999999999999999E20	-1E+21
0xC12E847FFFFFFFFFL	-999999.9999999999	-1000000
0xBE45798EE2308C39L	-9.999999999999999E-9	-0.00000001
0xBC32725DD1D243ABL	-9.999999999999999E-19	-0.000000000000000001
0xBBFD83C94FB6D2ABL	-9.999999999999999E-20	-1E-19
0xFFFF0420003C0000L	NaN	3.484840871308E+308
0x7FF8000000000000L	NaN	2.6965397022935E+308
0x7FFF0420003C0000L	NaN	3.484840871308E+308
0xFFF8000000000000L	NaN	2.6965397022935E+308
0xFFFF0AAAAAAAAAAAL	NaN	3.4877119413344E+308
0x7FF80AAAAAAAAAAAL	NaN	2.7012211948322E+308
0xFFFFFFFFFFFFFFFFL	NaN	3.5953862697246E+308
0x7FFFFFFFFFFFFFFFL	NaN	3.5953862697246E+308
0xFFF7FFFFFFFFFFFFL	NaN	2.6965397022935E+308

Property name	Value type	Value given to
{@value org.opengis.referencing.IdentifiedObject#NAME_KEY}	{@link String} or {@link ReferenceIdentifier}	{@link #getName()}
{@value org.opengis.referencing.IdentifiedObject#ALIAS_KEY}	{@link String}, `{@linkplain String}[]`, + * {@link GenericName} or `{@linkplain GenericName}[]`	{@link #getAlias}
{@value org.opengis.metadata.Identifier#AUTHORITY_KEY}	{@link String} or {@link Citation}	{@link ReferenceIdentifier#getAuthority} on the {@linkplain #getName() name}
{@value org.opengis.referencing.ReferenceIdentifier#CODESPACE_KEY}	{@link String}	{@link ReferenceIdentifier#getCodeSpace} on the {@linkplain #getName() name}
{@value org.opengis.referencing.ReferenceIdentifier#VERSION_KEY}	{@link String}	{@link ReferenceIdentifier#getVersion} on the {@linkplain #getName() name}
{@value org.opengis.referencing.IdentifiedObject#IDENTIFIERS_KEY}	{@link ReferenceIdentifier} or `{@linkplain ReferenceIdentifier}[]`	{@link #getIdentifiers}
{@value org.opengis.referencing.IdentifiedObject#REMARKS_KEY}	{@link String} or {@link InternationalString}	{@link #getRemarks}

Property name	Value type	Value given to
{@link #DOMAIN_OF_VALIDITY_KEY "domainOfValidity"}	{@link Extent}	{@link #getDomainOfValidity}
{@link #SCOPE_KEY "scope"}	{@link String} or {@link InternationalString}	{@link #getScope}

This method argument	{@linkplain Hints#FORCE_LONGITUDE_FIRST_AXIS_ORDER Hint} value	Meaning
{@code true}	{@link Boolean#TRUE TRUE}	All coordinate reference systems are forced to + * (`longitude`, `latitude`) axis order.
{@code false}	{@code null}	Coordinate reference systems may or may not be forced to + * (`longitude`, `latitude`) axis order. The behavior depends on user + * setting, for example the value of the `{@value + * org.geotools.referencing.factory.epsg.LongitudeFirstFactory#SYSTEM_DEFAULT_KEY}` + * system property.
	{@link Boolean#FALSE FALSE}	Forcing (`longitude`, `latitude`) axis order is not allowed, + * no matter the value of the `{@value + * org.geotools.referencing.factory.epsg.LongitudeFirstFactory#SYSTEM_DEFAULT_KEY}` + * system property.

Property name	Value type	Value given to
{@link #CODE_KEY "code"}	{@link String}	{@link #getCode}
{@link #CODESPACE_KEY "code"}	{@link String}	{@link #getCodeSpace}
{@link #AUTHORITY_KEY "authority"}	{@link String} or {@link Citation}	{@link #getAuthority}
{@link #VERSION_KEY "version"}	{@link String}	{@link #getVersion}
{@link #REMARKS_KEY "remarks"}	{@link String} or {@link InternationalString}	{@link #getRemarks}

North along 90 deg East,	North along 0 deg
North along 75 deg West,	North along 165 deg West
South along 90 deg West,	South along 0 deg
South along 180 deg,	South along 90 deg West
North along 130 deg West	North along 140 deg East

Property name	Value type	Value given to
{@link #ANCHOR_POINT_KEY "anchorPoint"}	{@link InternationalString} or {@link String}	{@link #getAnchorPoint}
{@link #REALIZATION_EPOCH_KEY "realizationEpoch"}	{@link Date}	{@link #getRealizationEpoch}
{@link #DOMAIN_OF_VALIDITY_KEY "domainOfValidity"}	{@link Extent}	{@link #getDomainOfValidity}
{@link #SCOPE_KEY "scope"}	{@link InternationalString} or {@link String}	{@link #getScope}

Required software	Data source	Plugin / JAR file	Additional notes
MS-Access ODBC driver	{@link org.geotools.referencing.factory.epsg.FactoryOnAccess}	{@code epsg-access}	See installation instructions
HSQL embedded database	{@link org.geotools.referencing.factory.epsg.FactoryOnHSQL}	{@code epsg-hsql}	Note for module mainteners
PostgreSQL database	{@link org.geotools.referencing.factory.epsg.FactoryOnPostgreSQL}	{@code epsg-postgresql}	Note for module mainteners

Mask	Description
0x01	is16bitEncoded
0x04	hasExtendedData
0x08	isRichText

EPSG name	EPSG code
Geocentric translations	9603
Position Vector 7-param. transformation	9606
Coordinate Frame rotation	9607

{@link org.geotools.referencing.FactoryFinder#main FactoryFinder}	Lists registered factories found in the class path (not only Geotools implementations).
{@link org.geotools.referencing.operation.DefaultMathTransformFactory#main DefaultMathTransformFactory}	Lists registered math transforms found in the class path.
{@link org.geotools.referencing.CRS#main CRS}	Prints some informations about objects specified by their authority codes.
{@link org.geotools.referencing.Console Console}	A command-line tool for testing transformations.

Property name	Value type	Value given to
{@value org.opengis.referencing.operation.CoordinateOperation#OPERATION_VERSION_KEY}	{@link String}	{@link #getOperationVersion}
{@value org.opengis.referencing.operation.CoordinateOperation#COORDINATE_OPERATION_ACCURACY_KEY}	`{@linkplain PositionalAccuracy}[]`	{@link #getCoordinateOperationAccuracy}
{@value org.opengis.referencing.operation.CoordinateOperation#DOMAIN_OF_VALIDITY_KEY}	{@link Extent}	{@link #getDomainOfValidity}
{@value org.opengis.referencing.operation.CoordinateOperation#SCOPE_KEY}	{@link String} or {@link InternationalString}	{@link #getScope}

Property name	Value type	Value given to
{@value org.opengis.referencing.IdentifiedObject#NAME_KEY}	{@link org.opengis.referencing.ReferenceIdentifier} or {@link String}	{@link IdentifiedObject#getName}
{@value org.opengis.referencing.IdentifiedObject#ALIAS_KEY}	{@link String}, `{@linkplain String}[]`, + * {@link GenericName} or `{@linkplain GenericName}[]`	{@link IdentifiedObject#getAlias}
{@value org.opengis.metadata.Identifier#AUTHORITY_KEY}	{@link String} or {@link Citation}	{@link Identifier#getAuthority} on the {@linkplain IdentifiedObject#getName name}
{@value org.opengis.referencing.ReferenceIdentifier#CODESPACE_KEY}	{@link String}	{@link ReferenceIdentifier#getCodeSpace} on the {@linkplain IdentifiedObject#getName name}
{@value org.opengis.referencing.ReferenceIdentifier#VERSION_KEY}	{@link String}	{@link ReferenceIdentifier#getVersion} on the {@linkplain IdentifiedObject#getName name}
{@value org.opengis.referencing.IdentifiedObject#IDENTIFIERS_KEY}	{@link Identifier} or `{@linkplain Identifier}[]`	{@link IdentifiedObject#getIdentifiers}
{@value org.opengis.referencing.IdentifiedObject#REMARKS_KEY}	{@link String} or {@link InternationalString}	{@link IdentifiedObject#getRemarks}

Robustness

Computational Performance

Package Specification

Binary Predicates

Overlay Methods

Representation of Computed Geometries

Constructed Points And The Precision Model

Geometry Equality

Structural Equality

Topological Equality

Package Specification

Package Specification

Package Specification

Package Specification

Labeling isolated components

Package Specification

UML Diagram

Standart/NonStandard Units

Usage examples:

Unit Parameterization

UML Diagram

Main features

History

To Do

Related Documentation

Related Documentation

Related Documentation

Related Documentation

Related Documentation

Related Documentation

Related Documentation

Related Documentation

Related Documentation

Related Documentation

Related Documentation

Related Documentation

Related Documentation

Description

Contents

Lifecycle

Implementation Notes

Implementation Notes

Questions and Suggestions

How hints are set

Life Cycle of Iterator

Notes for SimpleFeatureCollection Implementors

Implementation Notes

Expression

Design note

Note on factory ordering

For More Information

Command-line tools

Identifiable

Validation

Property Access

Xpath and Query Language Access

Attribute Access

Attribute Indexing

Attribute Multiplicity

Attribute Naming

Identifiablily

Binding

Restrictions

Inheritance

Abstract Types

Example

Type System

Differences from ISO 19103 with respect to Naming

Differences from ISO 19109 with respect to General Feature Model

Relationship to ISO 19109 Primer

Arithmetic operators

Literals

Functions

Data Access

Filter Encodings

Catalog and Web Feature Server

Comparison operators

Logical operators

Identity

FeatureCollections