ecologylab.semantics.metametadata
Class MetaMetadataField

java.lang.Object
  ecologylab.generic.Debug
      ecologylab.xml.ElementState
          ecologylab.semantics.metametadata.MetaMetadataField

All Implemented Interfaces:

PackageSpecifier, ecologylab.xml.ClassTypes, ecologylab.xml.types.element.Mappable<java.lang.String>, ecologylab.xml.XMLTranslationExceptionTypes, java.lang.Iterable<MetaMetadataField>

Direct Known Subclasses:

MetaMetadata

public class MetaMetadataField
extends ecologylab.xml.ElementState
implements ecologylab.xml.types.element.Mappable<java.lang.String>, PackageSpecifier, java.lang.Iterable<MetaMetadataField>

Author:

damaraju

Nested Class Summary

Nested classes/interfaces inherited from class ecologylab.xml.ElementState

ecologylab.xml.ElementState.DeclarationStyle, ecologylab.xml.ElementState.xml_attribute, ecologylab.xml.ElementState.xml_bind_from, ecologylab.xml.ElementState.xml_bind_to, ecologylab.xml.ElementState.xml_class, ecologylab.xml.ElementState.xml_classes, ecologylab.xml.ElementState.xml_collection, ecologylab.xml.ElementState.xml_format, ecologylab.xml.ElementState.xml_leaf, ecologylab.xml.ElementState.xml_map, ecologylab.xml.ElementState.xml_nested, ecologylab.xml.ElementState.xml_nowrap, ecologylab.xml.ElementState.xml_other_tags, ecologylab.xml.ElementState.xml_scope, ecologylab.xml.ElementState.xml_tag, ecologylab.xml.ElementState.xml_text

Field Summary

static java.util.Iterator<MetaMetadataField>

EMPTY_ITERATOR

Fields inherited from class ecologylab.xml.ElementState

CDATA, NORMAL, UTF16, UTF16_LE, UTF8

Fields inherited from interface ecologylab.xml.ClassTypes

BAD_FIELD, COLLECTION_ELEMENT, COLLECTION_SCALAR, IGNORED_ATTRIBUTE, IGNORED_ELEMENT, LEAF_NODE_VALUE, MAP_ELEMENT, MAP_SCALAR, NAME_SPACE_ATTRIBUTE, NAME_SPACE_LEAF_NODE, NAME_SPACE_MASK, NAME_SPACE_NESTED_ELEMENT, NAMESPACE_IGNORED_ELEMENT, NAMESPACE_TRIAL_ELEMENT, OTHER_NESTED_ELEMENT, REGULAR_ATTRIBUTE, REGULAR_NESTED_ELEMENT, ROOT, TEXT_NODE_VALUE, UNSET_TYPE, XMLNS_ATTRIBUTE, XMLNS_IGNORED

Fields inherited from interface ecologylab.xml.XMLTranslationExceptionTypes

FILE_NOT_FOUND, IO_EXCEPTION, NULL_PURL, UNKNOWN

Constructor Summary

MetaMetadataField()

MetaMetadataField(java.lang.String name, ecologylab.xml.types.scalar.ScalarType metadataType, ecologylab.generic.HashMapArrayList<java.lang.String,MetaMetadataField> set)

Method Summary

java.lang.String	collection()
ecologylab.generic.HashMapArrayList<java.lang.String,MetaMetadataField>	getChildMetaMetadata()
java.lang.String	getChildTag()
java.lang.String	getCollectionChildType()
java.lang.String	getContextNode()
java.lang.String	getExtendsField()
java.lang.String	getKey()
ecologylab.xml.types.scalar.ScalarType	getMetadataType()
MetaMetadataRepository	getMmdRepository()
java.lang.String	getName()
java.lang.String	getNavigatesTo()
java.lang.String	getRegularExpression()
java.lang.String	getReplacementString()
ecologylab.xml.types.scalar.ScalarType	getScalarType()
ecologylab.generic.HashMapArrayList<java.lang.String,MetaMetadataField>	getSet()
java.lang.String	getStringPrefix()
java.lang.String	getTag()
java.lang.String	getTagDecl() If a tag was declared, form an ecologylab.xml @xml_tag declaration with it.
java.lang.String	getType()
java.lang.String	getTypeAttribute()
java.lang.String	getXpath()
void	inheritMetaMetadata(MetaMetadataRepository repository) Bind field declarations through the extends and type keywords.
boolean	isAlwaysShow()
boolean	isEntity()
boolean	isGenerateClass()
boolean	isHide()
boolean	isIgnoreInTermVector()
boolean	isNested()
java.util.Iterator<MetaMetadataField>	iterator()
java.lang.String	key()
MetaMetadataField	lookupChild(ecologylab.xml.FieldDescriptor fieldAccessor)
MetaMetadataField	lookupChild(java.lang.String name)
ecologylab.textformat.NamedStyle	lookupStyle()
static void	main(java.lang.String[] args)
MetaMetadataRepository	metaMetadataRepository()
java.lang.String	packageName()
void	setChildMetaMetadata(ecologylab.generic.HashMapArrayList<java.lang.String,MetaMetadataField> childMetaMetadata)
void	setExtendsField(java.lang.String extendsField)
void	setGenerateClass(boolean generateClass)
void	setKey(java.lang.String key)
void	setMmdRepository(MetaMetadataRepository mmdRepository)
void	setNested(boolean isNested)
void	setRegularExpression(java.lang.String regularExpression)
void	setReplacementString(java.lang.String replacementString)
void	setTag(java.lang.String tag)
java.lang.String	shadows()
int	size()
java.lang.String	toString()
void	translateToMetadataClass(java.lang.String packageName, java.lang.Appendable appendable, int pass, boolean appendedToTranslastionScope)

Methods inherited from class ecologylab.xml.ElementState

buildDOM, buildDOM, buildDOM, buildDOM, buildDOM, buildDOMFromXMLCharSequence, buildDOMFromXMLString, checkAnnotation, createParentDirs, getChildFieldAccessors, getElementStateById, getFieldDescriptors, getNestedNameSpace, getTextNodeString, hasScalarTextField, lookupNestedNameSpace, parent, propagateInheritedValues, recycle, setDeclarationStyle, setParent, setUseDOMForTranslateTo, translateFromXML, translateFromXML, translateFromXML, translateFromXML, translateFromXML, translateFromXMLCharSequence, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOMCharSequence, translateFromXMLDOMCharSequence, translateFromXMLRootNode, translateFromXMLSAX, translateFromXMLSAX, translateFromXMLSAX, translateFromXMLSAX, translateFromXMLSAX, translateToDOM, translateToXML, translateToXML, translateToXML, translateToXML, writePrettyXML, writePrettyXML, writePrettyXML

Methods inherited from class ecologylab.generic.Debug

classSimpleName, closeLoggingFile, debug, debug, debug, debug, debugA, debugA, debugA, debugI, debugI, debugI, error, error, getClassName, getClassName, getInteractive, getPackageName, getPackageName, getPackageName, initialize, level, level, level, logToFile, print, print, println, println, println, println, println, println, printlnA, printlnA, printlnA, printlnI, printlnI, printlnI, printlnI, setLoggingFile, show, show, superString, toggleInteractive, toString, warning, warning, weird, weird

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_ITERATOR

public static java.util.Iterator<MetaMetadataField> EMPTY_ITERATOR

Constructor Detail

MetaMetadataField

public MetaMetadataField()

MetaMetadataField

public MetaMetadataField(java.lang.String name,
                         ecologylab.xml.types.scalar.ScalarType metadataType,
                         ecologylab.generic.HashMapArrayList<java.lang.String,MetaMetadataField> set)

Method Detail

packageName

public java.lang.String packageName()

Specified by:

packageName in interface PackageSpecifier

translateToMetadataClass

public void translateToMetadataClass(java.lang.String packageName,
                                     java.lang.Appendable appendable,
                                     int pass,
                                     boolean appendedToTranslastionScope)
                              throws ecologylab.xml.XMLTranslationException,
                                     java.io.IOException

Throws:

ecologylab.xml.XMLTranslationException

java.io.IOException

main

public static void main(java.lang.String[] args)
                 throws ecologylab.xml.XMLTranslationException

Throws:

ecologylab.xml.XMLTranslationException

size

public int size()

getSet

public ecologylab.generic.HashMapArrayList<java.lang.String,MetaMetadataField> getSet()

getName

public java.lang.String getName()

key

public java.lang.String key()

Specified by:

key in interface ecologylab.xml.types.element.Mappable<java.lang.String>

getMetadataType

public ecologylab.xml.types.scalar.ScalarType getMetadataType()

lookupChild

public MetaMetadataField lookupChild(java.lang.String name)

lookupChild

public MetaMetadataField lookupChild(ecologylab.xml.FieldDescriptor fieldAccessor)

getXpath

public java.lang.String getXpath()

getStringPrefix

public java.lang.String getStringPrefix()

getKey

public java.lang.String getKey()

Returns:

the key

getScalarType

public ecologylab.xml.types.scalar.ScalarType getScalarType()

Returns:

the scalarType

setKey

public void setKey(java.lang.String key)

Parameters:

key - the key to set

isHide

public boolean isHide()

isIgnoreInTermVector

public boolean isIgnoreInTermVector()

inheritMetaMetadata

public void inheritMetaMetadata(MetaMetadataRepository repository)

Bind field declarations through the extends and type keywords.

setChildMetaMetadata

public void setChildMetaMetadata(ecologylab.generic.HashMapArrayList<java.lang.String,MetaMetadataField> childMetaMetadata)

Parameters:

childMetaMetadata - the childMetaMetadata to set

iterator

public java.util.Iterator<MetaMetadataField> iterator()

Specified by:

iterator in interface java.lang.Iterable<MetaMetadataField>

isAlwaysShow

public boolean isAlwaysShow()

getCollectionChildType

public java.lang.String getCollectionChildType()

shadows

public java.lang.String shadows()

getNavigatesTo

public java.lang.String getNavigatesTo()

getChildMetaMetadata

public ecologylab.generic.HashMapArrayList<java.lang.String,MetaMetadataField> getChildMetaMetadata()

Returns:

the childMetaMetadata

isNested

public boolean isNested()

Returns:

the isNested

setNested

public void setNested(boolean isNested)

Parameters:

isNested - the isNested to set

collection

public java.lang.String collection()

metaMetadataRepository

public MetaMetadataRepository metaMetadataRepository()

lookupStyle

public ecologylab.textformat.NamedStyle lookupStyle()

getRegularExpression

public java.lang.String getRegularExpression()

Returns:

the regularExpression

setRegularExpression

public void setRegularExpression(java.lang.String regularExpression)

Parameters:

regularExpression - the regularExpression to set

getReplacementString

public java.lang.String getReplacementString()

Returns:

the replacementString

setReplacementString

public void setReplacementString(java.lang.String replacementString)

Parameters:

replacementString - the replacementString to set

getExtendsField

public java.lang.String getExtendsField()

Returns:

the extendsField

setExtendsField

public void setExtendsField(java.lang.String extendsField)

Parameters:

extendsField - the extendsField to set

getMmdRepository

public MetaMetadataRepository getMmdRepository()

Returns:

the mmdRepository

setMmdRepository

public void setMmdRepository(MetaMetadataRepository mmdRepository)

Parameters:

mmdRepository - the mmdRepository to set

getContextNode

public final java.lang.String getContextNode()

Returns:

the contextNode

isGenerateClass

public boolean isGenerateClass()

Returns:

the generateClass

setGenerateClass

public void setGenerateClass(boolean generateClass)

Parameters:

generateClass - the generateClass to set

getType

public java.lang.String getType()

getTypeAttribute

public java.lang.String getTypeAttribute()

toString

public java.lang.String toString()

Overrides:

toString in class ecologylab.generic.Debug

isEntity

public boolean isEntity()

getChildTag

public java.lang.String getChildTag()

getTag

public java.lang.String getTag()

Returns:

the tag

getTagDecl

public java.lang.String getTagDecl()

If a tag was declared, form an ecologylab.xml @xml_tag declaration with it.

Returns:

The @xml_tag declaration string, or the empty string.

setTag

public void setTag(java.lang.String tag)

Parameters:

tag - the tag to set