fr.tireme.schemadoc.reorganize
Class SchemaObjInfo

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

public class SchemaObjInfo
extends java.lang.Object

Retains information on each object found in schemas.

The information includes :
• the name of the object as defined in the schema
• the full ID of the object
• the schema ID where it is defined
• the namespace of the object, if exist
• the type of the object
• the id of the documentation location, if exists

Note: if the object is a schema itself, isASchemaObject() will return true

Author:

pierre

Constructor Summary

SchemaObjInfo(java.lang.String schemaId_, java.lang.String namespace_, boolean managed_, org.w3c.dom.Element definition_)

SchemaObjInfo(java.lang.String id_, java.lang.String namespace_, java.lang.String schemaId_, boolean managed_, java.lang.String name_, java.lang.String type_, org.w3c.dom.Element definition_)

Method Summary

void	addUsedBy(SchemaObjInfo userSoi)
java.lang.String	getAStringDefinition()
org.w3c.dom.Element	getElementDefinition()
java.lang.String	getId()
java.lang.String	getName()
java.lang.String	getNamespace()
java.lang.String	getPrefixNamespace(java.util.Map<java.lang.String,java.lang.String> nsMap)
java.lang.String	getQName(java.util.Map<java.lang.String,java.lang.String> nsMap)
java.lang.String	getRedefinition()
java.lang.String	getSchemaId()
java.lang.String	getType()
java.util.Map<java.lang.String,SchemaObjInfo>	getUsedBy()
boolean	isASchemaObject()
boolean	isDocumented()
boolean	isDocumentedInAlsoDocumented()
boolean	isManaged()
boolean	isRedefinition()
void	setDocumented()
void	setDocumented(boolean doc)
void	setDocumentedInAlsoDocumented(boolean isDocumentedInAlsoDocumented)
void	setRedefinition(java.lang.String redefinition)

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaObjInfo

public SchemaObjInfo(java.lang.String schemaId_,
                     java.lang.String namespace_,
                     boolean managed_,
                     org.w3c.dom.Element definition_)

Parameters:

schemaId_ - String

namespace_ - String

managed_ - boolean

SchemaObjInfo

public SchemaObjInfo(java.lang.String id_,
                     java.lang.String namespace_,
                     java.lang.String schemaId_,
                     boolean managed_,
                     java.lang.String name_,
                     java.lang.String type_,
                     org.w3c.dom.Element definition_)

Parameters:

id_ - String

namespace_ - String

schemaId_ - String

managed_ - boolean

name_ - String

type_ - String

Method Detail

isDocumentedInAlsoDocumented

public boolean isDocumentedInAlsoDocumented()

Returns:

is Documented In Also Documented?

setDocumentedInAlsoDocumented

public void setDocumentedInAlsoDocumented(boolean isDocumentedInAlsoDocumented)

Parameters:

isDocumentedInAlsoDocumented -

addUsedBy

public void addUsedBy(SchemaObjInfo userSoi)

Parameters:

userSoi - SchemaObjInfo

getId

public java.lang.String getId()

Returns:

Returns the id.

getName

public java.lang.String getName()

Returns:

Returns the name.

getQName

public java.lang.String getQName(java.util.Map<java.lang.String,java.lang.String> nsMap)

Parameters:

nsMap - Map

Returns:

Returns the name.

getPrefixNamespace

public java.lang.String getPrefixNamespace(java.util.Map<java.lang.String,java.lang.String> nsMap)

getNamespace

public java.lang.String getNamespace()

Returns:

Returns the namespace.

getRedefinition

public java.lang.String getRedefinition()

Returns:

Returns the redefinition.

getSchemaId

public java.lang.String getSchemaId()

Returns:

Returns the schemaId.

getType

public java.lang.String getType()

Returns:

Returns the type.

getUsedBy

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

isASchemaObject

public boolean isASchemaObject()

Returns:

boolean

isDocumented

public boolean isDocumented()

Returns:

Returns the docId.

isManaged

public boolean isManaged()

Returns:

Returns the managed.

isRedefinition

public boolean isRedefinition()

Returns:

Returns the docId.

setDocumented

public void setDocumented()

setDocumented

public void setDocumented(boolean doc)

setRedefinition

public void setRedefinition(java.lang.String redefinition)

Parameters:

redefinition - The redefinition to set.

getElementDefinition

public org.w3c.dom.Element getElementDefinition()

getAStringDefinition

public java.lang.String getAStringDefinition()