fr.tireme.schemadoc.reorganize
Class IdentificationManagement

java.lang.Object
  fr.tireme.schemadoc.reorganize.IdentificationManagement

public class IdentificationManagement
extends java.lang.Object

Author:

pierre

Field Summary

static java.util.HashSet<java.lang.String>	SD_DOC_REFERENCES Documentation schemadoc object of an xs object (example sd:elemDocRef)
static java.util.HashSet<java.lang.String>	SD_MIXEDCONTENT_REFERENCES Inline mixed content Schemadoc references to xs objects (example sd:elemRef)

Constructor Summary

IdentificationManagement(boolean useXS2DTD, ReorganizeDoc _rd)

Method Summary

void	_addDocumentation(java.lang.String id, boolean isInAlsoDocuments)
void	addDocumentation(java.lang.String id)
void	addDocumentation(java.lang.String id, boolean isInAlsoDocuments)
void	addRedefinition(java.lang.String redefinedObj, java.lang.String redefinition) set the redefinition id as being redefined !
void	addSchemaToManagement(org.w3c.dom.Node n) Add a schema to the defined schema objects management
void	addUsedBy(java.lang.String objId, java.lang.String userObject)
java.lang.String	createId(org.w3c.dom.Node n) Makes an ID of the schema object that will be persistent along different sessions.
java.lang.String	getGenericID(java.lang.String id) Get an ID without taking into account the schema ID
java.lang.String	getIDName(java.lang.String id) Gets the name of an object
java.lang.String	getIDNamespace(java.lang.String id)
java.lang.String	getIDReference(org.w3c.dom.Node refNode) Makes an IDREF to a node, searching for the target and its ID
java.lang.String	getIDReference(java.lang.String schemaType, java.lang.String objectName, java.lang.String schemaID)
java.lang.String	getIDReferenceNS(java.lang.String namespace, java.lang.String schemaType, java.lang.String objectName, org.w3c.dom.Node n) Try to find an ID using schemaID default values found in node parents
java.lang.String	getIDReferenceNS(java.lang.String namespace, java.lang.String schemaType, java.lang.String objectName, java.lang.String schemaID)
java.lang.String	getIDType(java.lang.String id)
java.lang.String	getRedefinedObjectID(java.lang.String expandedQNameOrID, java.lang.String idSchema) Get the default ID from either an expanded ID or from an ID using the provided node context.
java.lang.String	getRedefinition(java.lang.String id)
SchemaObjInfo	getSOI(java.lang.String checkedName) Get the SOI information for a specific ID.
org.w3c.dom.Element	getSortedIndex(org.w3c.dom.Document doc) Create the index using the definedSchemaObjectsId Map
java.util.Map<java.lang.String,SchemaObjInfo>	getUsedBy(java.lang.String objId)
boolean	isDocumented(java.lang.String id)
boolean	isIdKnows(java.lang.String id)
boolean	isManaged(java.lang.String id)
boolean	isRedefinition(java.lang.String id)
boolean	isSchemaManaged(java.lang.String id)
java.lang.String	makeIDFromNS(java.lang.String namespace) Makes a valid string, without any spaces within.

Methods inherited from class java.lang.Object

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

Field Detail

SD_DOC_REFERENCES

public static final java.util.HashSet<java.lang.String> SD_DOC_REFERENCES

Documentation schemadoc object of an xs object (example sd:elemDocRef)

SD_MIXEDCONTENT_REFERENCES

public static final java.util.HashSet<java.lang.String> SD_MIXEDCONTENT_REFERENCES

Inline mixed content Schemadoc references to xs objects (example sd:elemRef)

Constructor Detail

IdentificationManagement

public IdentificationManagement(boolean useXS2DTD,
                                ReorganizeDoc _rd)
                         throws SDExcept,
                                StandardException

Parameters:

useXS2DTD - boolean

_rd - ReorganizeDoc

Throws:

SDExcept

StandardException

Method Detail

addDocumentation

public void addDocumentation(java.lang.String id)
                      throws SDExcept

Parameters:

id - String

Throws:

SDExcept

addDocumentation

public void addDocumentation(java.lang.String id,
                             boolean isInAlsoDocuments)
                      throws SDExcept

Throws:

SDExcept

_addDocumentation

public void _addDocumentation(java.lang.String id,
                              boolean isInAlsoDocuments)
                       throws SDExcept

Parameters:

id - String

Throws:

SDExcept

addRedefinition

public void addRedefinition(java.lang.String redefinedObj,
                            java.lang.String redefinition)
                     throws SDExcept

set the redefinition id as being redefined !

Parameters:

redefinedObj - String

redefinition - String

Throws:

SDExcept

addSchemaToManagement

public void addSchemaToManagement(org.w3c.dom.Node n)
                           throws SDExcept

Add a schema to the defined schema objects management

Parameters:

n - should be a schema object

Throws:

SDExcept

addUsedBy

public void addUsedBy(java.lang.String objId,
                      java.lang.String userObject)
               throws SDExcept

Parameters:

objId - the object used

userObject - the object using

Throws:

SDExcept

getSOI

public SchemaObjInfo getSOI(java.lang.String checkedName)
                     throws NotASchemaObjectException,
                            SDAbortExcept

Get the SOI information for a specific ID.

Parameters:

checkedName - internal SD full qualified name

Returns:

SchemaObjInfo

Throws:

NotASchemaObjectException - if the object is unknown, this standard exception is raised.

SDAbortExcept

createId

public java.lang.String createId(org.w3c.dom.Node n)
                          throws SDExcept

Makes an ID of the schema object that will be persistent along different sessions.

Parameters:

n - node that needs an ID

Returns:

The ID

Throws:

SDExcept

getGenericID

public java.lang.String getGenericID(java.lang.String id)
                              throws SDAbortExcept

Get an ID without taking into account the schema ID

Parameters:

id - String

Returns:

java.lang.String

Throws:

SDAbortExcept

getIDName

public java.lang.String getIDName(java.lang.String id)
                           throws SDExcept

Gets the name of an object

Parameters:

id - String

Returns:

java.lang.String

Throws:

SDExcept

getIDNamespace

public java.lang.String getIDNamespace(java.lang.String id)
                                throws SDExcept

Parameters:

id - String

Returns:

java.lang.String

Throws:

SDExcept

getIDReference

public java.lang.String getIDReference(org.w3c.dom.Node refNode)
                                throws NotASchemaObjectException,
                                       SDExcept,
                                       SDAbortExcept

Makes an IDREF to a node, searching for the target and its ID

Parameters:

refNode - the node making the refeence

Returns:

the IDREF created

Throws:

NotASchemaObjectException

SDExcept

SDAbortExcept

getIDReference

public java.lang.String getIDReference(java.lang.String schemaType,
                                       java.lang.String objectName,
                                       java.lang.String schemaID)
                                throws NotASchemaObjectException,
                                       SDExcept,
                                       SDAbortExcept

Parameters:

schemaType - String

objectName - String

schemaID - String

Returns:

java.lang.String

Throws:

NotASchemaObjectException

SDExcept

SDAbortExcept

getIDReferenceNS

public java.lang.String getIDReferenceNS(java.lang.String namespace,
                                         java.lang.String schemaType,
                                         java.lang.String objectName,
                                         org.w3c.dom.Node n)
                                  throws NotASchemaObjectException,
                                         SDExcept,
                                         SDAbortExcept

Try to find an ID using schemaID default values found in node parents

Parameters:

namespace - String

schemaType - String

objectName - String

n - Node

Returns:

java.lang.String

Throws:

NotASchemaObjectException

SDExcept

SDAbortExcept

getIDReferenceNS

public java.lang.String getIDReferenceNS(java.lang.String namespace,
                                         java.lang.String schemaType,
                                         java.lang.String objectName,
                                         java.lang.String schemaID)
                                  throws NotASchemaObjectException,
                                         SDExcept,
                                         SDAbortExcept

Parameters:

namespace - String

schemaType - String

objectName - String

schemaID - String

Returns:

java.lang.String

Throws:

NotASchemaObjectException

SDExcept

SDAbortExcept

getIDType

public java.lang.String getIDType(java.lang.String id)
                           throws SDExcept

Parameters:

id - String

Returns:

java.lang.String

Throws:

SDExcept

getRedefinedObjectID

public java.lang.String getRedefinedObjectID(java.lang.String expandedQNameOrID,
                                             java.lang.String idSchema)
                                      throws SDExcept,
                                             SDAbortExcept

Get the default ID from either an expanded ID or from an ID using the provided node context.

Parameters:

expandedQNameOrID - String

idSchema - String

Returns:

java.lang.String

Throws:

SDExcept

SDAbortExcept

getRedefinition

public java.lang.String getRedefinition(java.lang.String id)

Parameters:

id - String

Returns:

java.lang.String

getSortedIndex

public org.w3c.dom.Element getSortedIndex(org.w3c.dom.Document doc)

Create the index using the definedSchemaObjectsId Map

Parameters:

doc - Document

Returns:

org.w3c.dom.Element

getUsedBy

public java.util.Map<java.lang.String,SchemaObjInfo> getUsedBy(java.lang.String objId)
                                                        throws SDExcept

Parameters:

objId - String

Returns:

java.util.Map

Throws:

SDExcept

isDocumented

public boolean isDocumented(java.lang.String id)

Parameters:

id - String

Returns:

boolean

isIdKnows

public boolean isIdKnows(java.lang.String id)

Parameters:

id - String

Returns:

boolean

isManaged

public boolean isManaged(java.lang.String id)

Parameters:

id - String

Returns:

boolean

isRedefinition

public boolean isRedefinition(java.lang.String id)

Parameters:

id - String

Returns:

boolean

isSchemaManaged

public boolean isSchemaManaged(java.lang.String id)

Parameters:

id - String

Returns:

boolean

makeIDFromNS

public java.lang.String makeIDFromNS(java.lang.String namespace)

Makes a valid string, without any spaces within. This method is made public just because also used by graphic loading method.

Parameters:

namespace - the namespace from which creating the string

Returns:

the well formed string