org.bimserver.shared

Class GuidCompressor

java.lang.Object

org.bimserver.shared.GuidCompressor

public class GuidCompressor
extends Object

This class is a service class providing methods to generation and conversion between compressed and uncompressed string representations of GUIDs according to the algorithms used by the Industry Foundation Classes (IFC). The algorithm is based on an implementation in c as follows: originally proposed by Jim Forester
implemented previously by Jeremy Tammik using hex-encoding
Peter Muigg, June 1998
Janos Maros, July 2000
This class is provided as-is with no warranty.

The class GuidCompressor is part of the OPEN IFC JAVA TOOLBOX package. Copyright: CCPL BY-NC-SA 3.0 (cc) 2008 Eike Tauscher, Jan Tulke

The OPEN IFC JAVA TOOLBOX package itself (except this class) is licensed under
Creative Commons Attribution-Non-Commercial- Share Alike 3.0 Germany.
Please visit http://www.openifctools.com for more information.

Version:

1.0 - 24.07.2009

Author:

Jan Tulke

Constructor Summary

Constructors

Constructor and Description
GuidCompressor()

Method Summary

Modifier and Type	Method and Description
static String	compressGuidString(String uncompressedString) Converts an uncompressed String representation of a GUID into a compressed one
static String	getCompressedStringFromGuid(Guid guid) Converts a Guid-object into a compressed string representation of a GUID
static boolean	getGuidFromCompressedString(String string, Guid guid) Reconstructs a Guid-object form an compressed String representation of a GUID
static Guid	getGuidFromUncompressedString(String uncompressedGuidString) Converts an uncompressed String representation in an Guid-object
static String	getNewIfcGloballyUniqueId() Generates a new GUID and returns a compressed string representation as used for IfcGloballyUniqueId
static String	getUncompressedStringFromGuid(Guid guid) Converts a Guid-object into a uncompressed String representation of a GUID
static void	main(String[] args)
static String	uncompressGuidString(String compressedString) Converts a compressed String representation of a GUID into an uncompressed one

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GuidCompressor

public GuidCompressor()

Method Detail

getNewIfcGloballyUniqueId

public static String getNewIfcGloballyUniqueId()

Generates a new GUID and returns a compressed string representation as used for IfcGloballyUniqueId

Returns:

String with a length of 22 characters

getGuidFromUncompressedString

public static Guid getGuidFromUncompressedString(String uncompressedGuidString)

Converts an uncompressed String representation in an Guid-object

Parameters:

uncompressedGuidString - the uncompressed String representation of a GUID

Returns:

an Guid-object

getCompressedStringFromGuid

public static String getCompressedStringFromGuid(Guid guid)

Converts a Guid-object into a compressed string representation of a GUID

Parameters:

guid - the Guid-object

Returns:

String with a length of 22 characters

getGuidFromCompressedString

public static boolean getGuidFromCompressedString(String string,
                                                  Guid guid)
                                           throws InvalidGuidException

Reconstructs a Guid-object form an compressed String representation of a GUID

Parameters:

string - compressed String representation of a GUID, 22 character long

guid - contains the reconstructed Guid as a result of this method

Returns:

true if no error occurred

Throws:

InvalidGuidException

getUncompressedStringFromGuid

public static String getUncompressedStringFromGuid(Guid guid)

Converts a Guid-object into a uncompressed String representation of a GUID

Parameters:

guid - the Guid-object to be converted

Returns:

the uncompressed String representation of a GUID

compressGuidString

public static String compressGuidString(String uncompressedString)

Converts an uncompressed String representation of a GUID into a compressed one

Parameters:

uncompressedString - the String representation which gets compressed

Returns:

the compressed String representation with a length of 22 characters

uncompressGuidString

public static String uncompressGuidString(String compressedString)
                                   throws InvalidGuidException

Converts a compressed String representation of a GUID into an uncompressed one

Parameters:

compressedString - the String representation which gets uncompressed

Returns:

the uncompressed String representation

Throws:

InvalidGuidException

main

public static void main(String[] args)