edu.uci.isr.xarch.hints
Class HintsContext

java.lang.Object
  edu.uci.isr.xarch.hints.HintsContext

All Implemented Interfaces:

IHintsContext, IXArchContext

public class HintsContext

extends Object

implements IHintsContext

The context object for the hints package. This object is used to create objects that are used in the hints namespace.

Author:

Automatically Generated by xArch apigen

Field Summary

protected static String	DEFAULT_ELT_NAME
protected Document	doc
protected IXArch	xArch

Fields inherited from interface edu.uci.isr.xarch.hints.IHintsContext

TYPE_METADATA

Constructor Summary

HintsContext(IXArch xArch)
Create a new HintsContext for the given IXArch object.

Method Summary

protected Element	createElement(String name)
IHints	createHints() Create an IHints object in this namespace.
IPropertyHint	createPropertyHint() Create an IPropertyHint object in this namespace.
IRenderingHints	createRenderingHints() Create an IRenderingHints object in this namespace.
IRenderingHints	createRenderingHintsElement() Create a top-level element of type IRenderingHints.
IVersionID	createVersionID() Create an IVersionID object in this namespace.
IXMLLink	createXMLLink() Create an edu.uci.isr.xarch.instance.IXMLLink object in this namespace.
Collection	getAllRenderingHintss(IXArch xArch) Gets all the IRenderingHints children from the given IXArch element.
IRenderingHints	getRenderingHints(IXArch xArch) Gets the IRenderingHints child from the given IXArch element.
XArchTypeMetadata	getTypeMetadata() Gets metadata describing the xsi:type of this element.
IXArch	getXArch() Get the IXArch object that this context is based upon.
IHints	recontextualizeHints(IHints value) Brings an IHints object created in another context into this context.
IPropertyHint	recontextualizePropertyHint(IPropertyHint value) Brings an IPropertyHint object created in another context into this context.
IRenderingHints	recontextualizeRenderingHints(IRenderingHints value) Brings an IRenderingHints object created in another context into this context.
IVersionID	recontextualizeVersionID(IVersionID value) Brings an IVersionID object created in another context into this context.
IXMLLink	recontextualizeXMLLink(IXMLLink value) Brings an edu.uci.isr.xarch.instance.IXMLLink object created in another context into this context.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ELT_NAME

protected static final String DEFAULT_ELT_NAME

See Also:

Constant Field Values

doc

protected Document doc

xArch

protected IXArch xArch

Constructor Detail

HintsContext

public HintsContext(IXArch xArch)

Create a new HintsContext for the given IXArch object.

Parameters:

xArch - XArch object to contextualize in this namespace.

Method Detail

getXArch

public IXArch getXArch()

Description copied from interface: IXArchContext

Get the IXArch object that this context is based upon.

Specified by:

getXArch in interface IXArchContext

Returns:

IXArch object upon which this context is based.

createElement

protected Element createElement(String name)

getTypeMetadata

public XArchTypeMetadata getTypeMetadata()

Description copied from interface: IXArchContext

Gets metadata describing the xsi:type of this element.

Specified by:

getTypeMetadata in interface IXArchContext

Returns:

metadata describing the xsi:type of this element.

createVersionID

public IVersionID createVersionID()

Create an IVersionID object in this namespace.

Specified by:

createVersionID in interface IHintsContext

Returns:

New IVersionID object.

recontextualizeVersionID

public IVersionID recontextualizeVersionID(IVersionID value)

Brings an IVersionID object created in another context into this context.

Specified by:

recontextualizeVersionID in interface IHintsContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createPropertyHint

public IPropertyHint createPropertyHint()

Create an IPropertyHint object in this namespace.

Specified by:

createPropertyHint in interface IHintsContext

Returns:

New IPropertyHint object.

recontextualizePropertyHint

public IPropertyHint recontextualizePropertyHint(IPropertyHint value)

Brings an IPropertyHint object created in another context into this context.

Specified by:

recontextualizePropertyHint in interface IHintsContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createHints

public IHints createHints()

Create an IHints object in this namespace.

Specified by:

createHints in interface IHintsContext

Returns:

New IHints object.

recontextualizeHints

public IHints recontextualizeHints(IHints value)

Brings an IHints object created in another context into this context.

Specified by:

recontextualizeHints in interface IHintsContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createXMLLink

public IXMLLink createXMLLink()

Create an edu.uci.isr.xarch.instance.IXMLLink object in this namespace.

Specified by:

createXMLLink in interface IHintsContext

Returns:

New edu.uci.isr.xarch.instance.IXMLLink object.

recontextualizeXMLLink

public IXMLLink recontextualizeXMLLink(IXMLLink value)

Brings an edu.uci.isr.xarch.instance.IXMLLink object created in another context into this context.

Specified by:

recontextualizeXMLLink in interface IHintsContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createRenderingHints

public IRenderingHints createRenderingHints()

Create an IRenderingHints object in this namespace.

Specified by:

createRenderingHints in interface IHintsContext

Returns:

New IRenderingHints object.

recontextualizeRenderingHints

public IRenderingHints recontextualizeRenderingHints(IRenderingHints value)

Brings an IRenderingHints object created in another context into this context.

Specified by:

recontextualizeRenderingHints in interface IHintsContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createRenderingHintsElement

public IRenderingHints createRenderingHintsElement()

Create a top-level element of type IRenderingHints. This function should be used in lieu of createRenderingHints if the element is to be added as a sub-object of IXArch.

Specified by:

createRenderingHintsElement in interface IHintsContext

Returns:

new IRenderingHints suitable for adding as a child of xArch.

getRenderingHints

public IRenderingHints getRenderingHints(IXArch xArch)

Gets the IRenderingHints child from the given IXArch element. If there are multiple matching children, this returns the first one.

Specified by:

getRenderingHints in interface IHintsContext

Parameters:

xArch - IXArch object from which to get the child.

Returns:

IRenderingHints that is the child of xArch or null if no such object exists.

getAllRenderingHintss

public Collection getAllRenderingHintss(IXArch xArch)

Gets all the IRenderingHints children from the given IXArch element.

Specified by:

getAllRenderingHintss in interface IHintsContext

Parameters:

xArch - IXArch object from which to get the children.

Returns:

Collection of IRenderingHints that are the children of xArch or an empty collection if no such object exists.