com.quinsoft.zeidon.SerializeOi Maven / Gradle / Ivy
/**
This file is part of the Zeidon Java Object Engine (Zeidon JOE).
Zeidon JOE is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Zeidon JOE is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with Zeidon JOE. If not, see viewList;
private StreamFormat format;
private String resourceName;
private EnumSet flags = EnumSet.noneOf( WriteOiFlags.class );
private StreamWriter streamWriter;
private Map rootSelectSets;
private boolean writeDate = false;
private boolean useCamelCase = false;
private boolean writeDerivedAttributes = false;
private boolean writeTotalRootCount = false;
private boolean writeCursors = false;
public SerializeOi()
{
viewList = new ArrayList<>();
}
public SerializeOi( View view, View... views )
{
this();
addView( view, views );
}
public SerializeOi( List views )
{
this();
addViews( views );
}
/**
* Writes the OI to a temp file. The name of the temp file is created using File.createTempFile
* with the name of the LOD and the desired extension (e.g. .XML or .JSON).
*
* @return the name of the generated file name.
*/
public String toTempFile()
{
if ( viewList.size() == 0 )
throw new ZeidonException( "Specify at least one view before calling toTempFile()" );
View view = viewList.get( 0 );
String prefix = view.getLodDef().getName() + "_";
File file;
try
{
file = File.createTempFile( prefix, getFormat().getExtension() );
}
catch ( IOException e )
{
throw ZeidonException.wrapException( e ).appendMessage( "Filename = %s", prefix );
}
return toFile( file.getAbsolutePath() );
}
/**
* Writes the OI to the system temp dir which is determined by java.io.tmpdir.
*
* @return the name of the generated file name.
*/
public String toTempDir( String baseFilename )
{
if ( viewList.size() == 0 )
throw new ZeidonException( "Specify at least one view before calling toTempDir()" );
String tempFile = System.getProperty( "java.io.tmpdir" ) + File.separator + baseFilename;
return toFile( tempFile );
}
/**
* Serializes the OI to the specified file name. If the format has not yet been specified
* the format will be determined (if possible) from the filename extension. E.g. "myfile.json"
* indicates the format is JSON.
*
* @param filename
*
* @return the filename
*/
public String toFile( String filename )
{
File file = new File( filename );
return toFile( file );
}
/**
* Convenience method that prepends the Zeidon HOME to the filename.
*
* @param filename
* @return
*/
public String toZeidonHomeFile( String filename )
{
if ( viewList.size() == 0 )
throw new ZeidonException( "Specify at least one view before calling toZeidonHomeFile()" );
String tfile = viewList.get( 0 ).getTask().getObjectEngine().getHomeDirectory();
// Append the dir separator if it's not specified.
if ( ! tfile.endsWith( "\\" ) && ! tfile.endsWith( "/" ) && filename.startsWith( "\\" ) && filename.startsWith( "/" ) )
tfile += "/";
tfile += filename;
return toFile( tfile );
}
/**
* Serializes the OI to the specified file name. If the format has not yet been specified
* the format will be determined (if possible) from the filename extension. E.g. "myfile.json"
* indicates the format is JSON.
*
* @param file
*
* @return the filename
*/
public String toFile( File file )
{
if ( viewList.size() == 0 )
throw new ZeidonException( "Specify at least one view before calling toFile()" );
String filename = file.getAbsolutePath();
FileWriter writer = null;
try
{
writer = new FileWriter( file );
resourceName = filename;
setFormatFromFilename( resourceName );
write( writer );
return resourceName;
}
catch ( Exception e )
{
throw ZeidonException.wrapException( e ).prependFilename( filename );
}
finally
{
IOUtils.closeQuietly( writer );
}
}
public Writer toWriter( Writer writer )
{
resourceName = "*External writer*";
write( writer );
return writer;
}
public void toAttribute( AttributeInstance attribute )
{
Writer writer = toStringWriter();
write( writer );
attribute.setValue( writer.toString() );
}
public String getResourceName()
{
return resourceName;
}
/**
* Write the OI to a StringWriter.
*
* @return
*/
public Writer toStringWriter()
{
StringWriter writer = new StringWriter();
resourceName = "*String*";
write( writer );
return writer;
}
/**
* Write the OI to a string and return the string.
*/
@Override
public String toString()
{
if ( viewList.size() == 0 )
return "";
return toStringWriter().toString();
}
/**
* Set the format depending on the extension of filename.
*
* @param filename
* @return
*/
private SerializeOi setFormatFromFilename( String filename )
{
if ( format != null )
return this;
for ( StreamFormat f : StreamFormat.values() )
{
if ( f.matches( filename ) )
{
format = f;
break;
}
}
return this;
}
public SerializeOi setFormat( StreamFormat format )
{
this.format = format;
return this;
}
public SerializeOi setFormat( String format )
{
this.format = StreamFormat.valueOf( format );
return this;
}
public SerializeOi asJson()
{
format = StreamFormat.JSON;
return this;
}
public SerializeOi asXml()
{
format = StreamFormat.XML;
return this;
}
/**
* If specified then write Entity and Attribute names using camel
* casing, which mostly sets the first character to lower-case.
*
* @return this
*/
public SerializeOi useCamelCase()
{
useCamelCase = true;
return this;
}
public boolean isCamelCase()
{
return useCamelCase;
}
/**
* If specified then write derived attributes and their values.
*
* @return this
*/
public SerializeOi writeDerivedAttributes()
{
writeDerivedAttributes = true;
return this;
}
public boolean isWriteDerivedAttributes()
{
return writeDerivedAttributes;
}
public SerializeOi writeDate()
{
setWriteDate( true );
return this;
}
public SerializeOi addView( View view, View... views )
{
viewList.add( view );
if ( views != null )
{
for ( View v : views )
viewList.add( v );
}
return this;
}
public SerializeOi addViews( Collection views )
{
viewList.addAll( views );
return this;
}
public List getViewList()
{
return viewList;
}
/**
* Get the streamWriter that will serialize the OI to the stream. If
* one hasn't been created then this will do so.
*
* @return
*/
private StreamWriter getStreamWriter()
{
if ( streamWriter == null )
{
switch ( getFormat() )
{
case JSON:
if ( flags.contains( WriteOiFlags.INCREMENTAL ) )
streamWriter = new WriteOisToJsonStream();
else
streamWriter = new WriteOisToJsonStreamNoIncrementals();
break;
case XML:
streamWriter = new WriteOisToXmlStream();
break;
case POR:
streamWriter = new WriteOiToPorStream();
break;
default:
throw new ZeidonException( "Unknown format", getFormat() );
}
}
return streamWriter;
}
private void write( Writer writer )
{
if ( viewList.size() == 0 )
throw new ZeidonException( "No views have been selected to write" );
if ( writer == null )
throw new ZeidonException( "No output destination specified." );
getStreamWriter().writeToStream( this, writer );
}
public EnumSet getFlags()
{
return flags;
}
public SerializeOi setFlags( EnumSet flags )
{
if ( flags == null )
flags = EnumSet.noneOf( WriteOiFlags.class );
this.flags = flags;
return this;
}
public SerializeOi setFlags( Long control )
{
if ( control == null )
return setFlags( (EnumSet) null );
return setFlags( WriteOiFlags.convertLongFlags( control ) );
}
public SerializeOi withIncremental()
{
flags.add( WriteOiFlags.INCREMENTAL );
return this;
}
public SerializeOi withIncremental( boolean incre )
{
if ( incre )
flags.add( WriteOiFlags.INCREMENTAL );
return this;
}
public SerializeOi withCursors()
{
writeCursors = true;
return this;
}
public boolean isWithCursors()
{
return writeCursors;
}
public SerializeOi using( StreamWriter streamWriter )
{
this.streamWriter = streamWriter;
return this;
}
/**
* @return the format. If it hasn't been set then the default is the Zeidon POR format.
*/
public StreamFormat getFormat()
{
// If format hasn't been set we'll default to POR.
if ( format == null )
return StreamFormat.POR;
return format;
}
public boolean isCompressed()
{
return flags.contains( WriteOiFlags.COMPRESSED );
}
public SerializeOi setCompressed( boolean compressed )
{
if ( compressed )
flags.add( WriteOiFlags.COMPRESSED );
else
flags.remove( WriteOiFlags.COMPRESSED );
return this;
}
public SerializeOi compressed()
{
return setCompressed( true );
}
public Map getRootSelectSets()
{
return rootSelectSets;
}
/**
* Only the root entities that are currently selected by a cursor
* will be written.
*
* @return
*/
public SerializeOi onlyCurrentRoots()
{
if ( rootSelectSets == null )
rootSelectSets = new HashMap<>();
for ( View v : viewList )
{
if ( ! rootSelectSets.containsKey( v.getOiId() ) )
{
SelectSet selectSet = v.createSelectSet();
selectSet.select( v.cursor( v.getLodDef().getRoot() ) );
rootSelectSets.put( v.getOiId(), selectSet );
}
}
return this;
}
/**
* Write the current date/time to the stream as "datetime".
*/
public boolean isWriteDate()
{
return writeDate;
}
public SerializeOi setWriteDate( boolean writeDate )
{
this.writeDate = writeDate;
return this;
}
public boolean isWriteTotalRootCount()
{
return writeTotalRootCount;
}
public SerializeOi setWriteTotalRootCount( boolean writeTotalRootCount )
{
this.writeTotalRootCount = writeTotalRootCount;
return this;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy